@somehiddenkey/discord-command-utils 1.0.2 → 1.1.0

package/README.md

@@ -1,20 +1,12 @@
 # DiscordUtilsLibrary
 The purpose of this Library is to hide and abstract many of the common aspects that comes with coding discord bots in javascript. The main focus is configurations as well as registering all types of commands and interactions between different guilds.
-## Installation
-### SSH Installation
-Use this if your GitHub account already has SSH access -> requires SSH key set up
+## Setup
+1. Installation
 ```bash
-npm install git+ssh://git@github.com/studytogether-discord/DiscordUtilsLibrary.git
+npm install @somehiddenkey/discord-command-utils --registry=https://registry.npmjs.org/
 ```
 
-### HTTPS Installation
-If you want to use HTTPS instead, you must use a GitHub Personal Access Token (classic) with repo permissions (replace "TOKEN" with your PAT)
-```bash
-npm install "https://TOKEN@github.com/studytogether-discord/DiscordUtilsLibrary.git"
-```
-
-### Libary Import
-Then import it in your code
+2. Libary Import
 ```c#
 import { Something } from "DiscordUtilsLibrary";
 // or
@@ -137,7 +129,7 @@ bot.on(Events.MessageCreate, async (message) => {
 });
 
 bot.on(Events.InteractionCreate, async (interaction) => 
-  await interactionContainer.call_interaction(message, e => consola.error(e))
+  await interactionContainer.call_interaction(interaction, e => consola.error(e))
 );
 ```
 ### Register slash commands to REST

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@somehiddenkey/discord-command-utils",
-  "version": "1.0.2",
+  "version": "1.1.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,8 +1,6 @@
-class ConfigError extends Error {
+export default class ConfigError extends Error {
   constructor(message) {
     super(message);
     this.name = "ConfigError";
   }
-}
-
-export default ConfigError;
+}

package/src/Configs/GlobalConfig.js

@@ -3,9 +3,9 @@
  */
 
 import fs from 'fs';
-import ConfigError from "./ConfigError";
+import ConfigError from "./ConfigError.js";
 import consola from 'consola';
-import { InteractionScope } from "../Utils/enums";
+import { InteractionScope } from "../Utils/enums.js";
 
 export default class GlobalConfig {
     /** @type {Guilds} */

package/src/Configs/LocalConfig.js

@@ -1,10 +1,11 @@
+import fs from 'fs';
+import ConfigError from "./ConfigError.js";
+import consola from 'consola';
+
 /**
  * @typedef {string} Snowflake
  */
 
-import { RESTOptions } from '@discordjs/rest';
-import { ActivitiesOptions } from 'discord.js';
-
 export default class LocalConfig {
     /** @type {string?} */
     prefix;
@@ -13,9 +14,9 @@ export default class LocalConfig {
 
     /** @type {object} */
     local;
-    /** @type {Partial<RESTOptions>} */
+    /** @type {object} */
     restOptions;
-    /** @type {ActivitiesOptions} */
+    /** @type {object} */
     activity;
 
     constructor(data) {
@@ -25,7 +26,7 @@ export default class LocalConfig {
         this.restOptions = data.rest_options || {};
         this.activity = data.activity || {};
 
-        if(!this.client_id)
+        if(!this.clientId)
             throw new ConfigError('No client_id initialized for LocalConfig');
     }
 
@@ -33,7 +34,7 @@ export default class LocalConfig {
      * Loads the JSON file and returns a GlobalConfig instance.
      * @param {string} path
      * @param {string} environment
-     * @returns {GlobalConfig}
+     * @returns {LocalConfig}
      */
     static async load(path, environment) {
         var json
@@ -41,12 +42,12 @@ export default class LocalConfig {
             const raw = fs.readFileSync(path, { encoding: 'utf8', flag: 'r' });
             json = JSON.parse(raw);
         } catch (error) {
-            consola.error(`Failed to load GlobalConfig from path: ${path}`, error);
+            consola.error(`Failed to load LocalConfig from path: ${path}`, error);
             throw error;
         }
         if (environment == "production") 
-            return new GlobalConfig({...json.production || json.activity});
+            return new LocalConfig({...json.production || json.activity});
         else 
-            return new GlobalConfig({...json.development || json.activity});
+            return new LocalConfig({...json.development || json.activity});
     }
 }

package/src/Configs/SecretConfig.js

@@ -1,5 +1,5 @@
 import consola from "consola";
-import ConfigError from "./ConfigError";
+import ConfigError from "./ConfigError.js";
 
 /**
  * @typedef {{client: string, connection: {host: string, user: string, password: string, database: string}}} DatabaseConfig

package/src/Interactions/CommandError.js

@@ -1,4 +1,5 @@
-import { Interaction as DiscordBaseInteraction, MessageFlags } from "discord.js";
+import pkg from 'discord.js';
+const { Interaction: DiscordBaseInteraction } = pkg;
 
 export default class CommandError extends Error {
   constructor(message) {

package/src/Interactions/Interaction.js

@@ -1,15 +1,16 @@
-import { 
-    Interaction as DiscordBaseInteraction,
+import InteractionContainer from "./InteractionContainer.js";
+import { InteractionType, InteractionScope } from "../Utils/enums.js";
+import pkg from 'discord.js';
+
+const { 
+    Interaction: DiscordBaseInteraction,
     OmitPartialGroupDMChannel,
     Message,
     ModalSubmitInteraction,
     ButtonInteraction,
     AnySelectMenuInteraction,
     ChatInputCommandInteraction,
-    CacheType
-} from 'discord.js';
-import InteractionContainer from "./InteractionContainer";
-import { InteractionType, InteractionScope } from "../Utils/enums";
+    CacheType } = pkg;
 
 /**
  * @typedef { (interaction: DiscordBaseInteraction<CacheType>) => Promise<any> } InteractionFunction

package/src/Interactions/InteractionContainer.js

@@ -1,16 +1,17 @@
-import { 
-    Interaction as DiscordBaseInteraction,
+import Interaction from "./Interaction.js";
+import { InteractionScope, InteractionType } from "../Utils/enums.js";
+import GlobalConfig from "../Configs/GlobalConfig.js";
+import LocalConfig  from "../Configs/LocalConfig.js";
+import consola from "consola";
+import CommandError from "./CommandError.js";
+import RestCommands from './RestCommands.js';
+import pkg from 'discord.js';
+const { 
+    Interaction: DiscordBaseInteraction,
     OmitPartialGroupDMChannel,
     Message,
     CacheType
-} from 'discord.js';
-import Interaction from "./Interaction";
-import { InteractionScope, InteractionType } from "../Utils/enums";
-import GlobalConfig from "../Configs/GlobalConfig";
-import LocalConfig  from "../Configs/LocalConfig";
-import consola from "consola";
-import CommandError from "./CommandError";
-import RestCommands from './RestCommands';
+} = pkg;
 
 /**
  * @typedef { (interaction: DiscordBaseInteraction<CacheType>) => Promise<any> } InteractionFunction

package/src/Interactions/RestCommands.js

@@ -1,6 +1,5 @@
-import { InteractionScope } from "../Utils/enums";
-import GlobalConfig from "../Configs/GlobalConfig";
-import LocalConfig  from "../Configs/LocalConfig";
+import GlobalConfig from "../Configs/GlobalConfig.js";
+import LocalConfig  from "../Configs/LocalConfig.js";
 import { REST } from "discord.js";
 
 export default class RestCommands {

package/src/Utils/checks.js

@@ -1,5 +1,5 @@
 import { BaseInteraction } from "discord.js";
-import { Modlevel } from "./enums";
+import { Modlevel } from "./enums.js";
 
 
 /**