@somehiddenkey/discord-command-utils 2.1.0 → 2.1.2

package/README.md

@@ -62,7 +62,7 @@ Your local configuration JSON file should look like this:
 ### Global configuration
 Loads the global configuration that contains information related to all bot instances, like snowflake IDs of channels, categories, guild, etc. Load a new instance of your global config through the following code:
 ```js
-export const globalConfig = GlobalConfig.load("../global_config.json");
+export const globalConfig = GlobalConfig.load("../global_config.json", bot);
 ```
 It contains the IDs of the following sections: guilds, categories, channels, log channels and roles. These can be used as constant values throughout your code, making sure that if an ID ever changes, that all bot instances would take the new updated value by simply updating the json once.
 

package/package.json

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

package/src/Configs/GlobalConfig/GlobalConfig.js

@@ -5,26 +5,31 @@
 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
-
+    
     /**
      * Loads the JSON file and returns a GlobalConfig instance.
      * @param {string} path
-     * @param {string} environment
+     * @param {Client} bot
      * @returns {GlobalConfig}
      */
-    static async load(path) {
-        var json
+    static async load(path, bot) {
+        var json;
         try {
             const raw = fs.readFileSync(path, { encoding: 'utf8', flag: 'r' });
             json = JSON.parse(raw);
@@ -32,7 +37,7 @@ export default class GlobalConfig {
             consola.error(`Failed to load GlobalConfig from path: ${path}`, error);
             throw error;
         }
-        return new GlobalConfig(json.guilds);
+        return new GlobalConfig(json.guilds, bot);
     }
 
         /**
@@ -73,11 +78,11 @@ export default class GlobalConfig {
         }
     }
 
-    constructor(data) {
-        this.main = new GuildMain(data.main);
-        this.community = new GuildCommunity(data.community);
-        this.tutor = new GuildTutor(data.tutor);
-        this.staff = new GuildStaff(data.staff);
+    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);
     }
 }
 

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, 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);
     }
 }
 
-class Categories extends ChannelBased {}
+class CategoriesCommunity extends ChannelBased {}
 
 class Channels 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,29 +7,29 @@ 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) {
+    constructor(data, bot) {
         if (!data) 
             throw new ConfigError('No data initialized for GlobalConfig');
 
-        super(data);
-        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);
+        super(data, bot);
+        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>} */
@@ -65,14 +65,14 @@ class Categories extends ChannelBased {
     /** @type {Set<Snowflake>} */
     study_rooms;
 
-    constructor(data) {
-        super(data);
+    constructor(data, guild) {
+        super(data, guild);
         this.custom_study_rooms = new Set(data.custom_rooms.concat(data.verified_com));
         this.study_rooms = new Set([...this.custom_study_rooms, data.music, data.timer_25, data.timer_50, data.screen_cam]);
     }
 }
 
-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} */
@@ -166,8 +166,8 @@ class Roles extends RoleBased {
     all_staff;
 
 
-    constructor(data) {
-        Object.assign(this, data);
+    constructor(data, guild) {        
+        super(data, guild);
         this.all_staff = [this.jr_staff, this.sr_staff, this.st_team, this.coordinator];
     }
 }

package/src/Configs/GlobalConfig/GlobalConfigStaff.js

@@ -7,32 +7,32 @@ 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) {
+    constructor(data, bot) {
         if (!data) 
             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);
+        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);
     }
 }
 
-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,32 +7,32 @@ 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) {
+    constructor(data, bot) {
         if (!data) 
             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);
+        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);
     }
 }
 
-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/NestedGlobalConfig.js

@@ -17,12 +17,12 @@ export class GuildBased extends Fetchable {
      * @param {Snowflake} id 
      * @returns {Proxy}
      */
-    _createLazyObject(id) {
+    _createLazyObject(id, bot) {
         return super._createLazyObject(id, async (id) => await bot.guilds.fetch(id));
     }
 
-    constructor(data){
-        this.guild = this._createLazyObject(data.id);
+    constructor(data, bot) {
+        this.guild = this._createLazyObject(data.id, bot);
         this._config_keys = Object.keys(data).filter(k => k !== 'id').push('guild');
     }
 }
@@ -49,7 +49,7 @@ export class RoleBased extends Fetchable {
     /** @type {Guild} */
     #guild;
 
-    constructor(data) {
+    constructor(data, guild) {
         this.#guild = guild;
         super(data);
     }

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',