discord-bot-shared 0.3.2 → 0.4.0

package/README.md

@@ -1 +1,153 @@
 # discord-bot-shared
+
+A module that makes creating discord.js bots a bit easier.
+
+## Installation/Usage
+
+```
+npm install discord-bot-shared
+```
+
+- This module expects a `BOT_TOKEN` and `CLIENT_ID` environment variable to login.
+  - By default, commands are registered globally. To register commands to a specific guild, you can optionally provide `GUILD_ID`.
+
+```
+// index.ts
+import login from 'discord-bot-shared'
+import { ClientOptions, GatewayIntentBits as Intents, Partials } from 'discord.js'
+
+const botIntents: ClientOptions = {
+  intents: [Intents.Guilds],
+  partials: [Partials.Reaction],
+}
+
+const bot = await login(botIntents, import.meta.url)
+
+export default bot
+```
+
+**You must have a directory names `events` and `commands` next to your `index.ts` (or wherever you are importing `login()` from).**
+
+```
+.
+└── src/
+    ├── events/
+    │   └── someEvent.ts
+    ├── commands/
+    │   └── someCommand.ts
+    └── index.ts
+```
+
+### Events
+
+This module registers your bot's events by `import`ing each file under your `events` directory. Events are registered as a side-effect of the import.
+
+```
+// guildMemberAdd.ts
+import bot from '../index.js'
+
+bot.on('guildMemberAdd', (member) => {
+  // do stuff
+})
+```
+
+### Commands
+
+Your commands are registered by `import`ing the default export of each command file.
+
+```
+// myCommand.ts
+import { Command } from 'discord-bot-shared'
+import { SlashCommandBuilder } from 'discord.js'
+
+const myCommand: Command = {
+  command: new SlashCommandBuilder()
+    .setName('my-command')
+    .setDescription('This command does stuff.') as SlashCommandBuilder,
+  run: (interaction) => {
+    // do stuff
+  },
+}
+
+export default myCommand
+```
+
+Your `run` function is passed the command interaction that initiated the command.
+
+### Exports
+
+The following functions and interfaces/types are exported by this module:
+
+---
+
+#### `function login`
+
+```
+async function login(
+  botIntents: ClientOptions,
+  projectMetaURL: string,
+  interactionCheck?: InteractionCheck,
+): Promise<Client>
+```
+
+- `botIntents` is a discord.js `ClientOptions` object.
+- `projectMetaURL` should always be passed `import.meta.url`. This is used to find and register your events and commands.
+- Optionally provide an `interactionCheck` function that returns a boolean. This function is called right before trying to run a command. The command will only run if `interactionCheck` returns true.
+  - The `InteractionCheck` type is also exported by this module.
+
+---
+
+#### `function getGuildCache`
+
+Returns an object that contains the guild and the following freshly fetched guild collections: `channels, emojis, members, roles`.
+
+```
+async function getGuildCache()
+```
+
+- For example, a common pattern I use is something like this:
+
+```
+const { members } = await getGuildCache()
+// do stuff with members
+```
+
+---
+
+#### `interface Command`
+
+This interface defines the structure of your bot's commands. See above for an example of a command.
+
+```
+interface Command {
+  requiredRoles?: string[]
+  command: SlashCommandBuilder
+  run: (interaction: ChatInputCommandInteraction) => void | Promise<void>
+}
+```
+
+- Optionally provide `requiredRoles` string array. If the member initiating the command has _any_ of the roles provided in this array, they will be allowed to run the command.
+- **You may have to type cast your command `as SlashCommandBuilder` due to the way discord.js' `SlashCommandBuilder` works.**
+- `run` is the final function that will be called to run your command.
+
+---
+
+#### `function getChannelByName`
+
+Returns a guild channel of the given name and type, otherwise returns `undefined`.
+
+```
+async function getChannelByName<T extends NonThreadGuildBasedChannel>(
+  channelName: string,
+  channelType: NonThreadGuildBasedChannelType,
+): Promise<T | undefined>
+```
+
+- `T` can be one of `TextChannel | VoiceChannel | NewsChannel | StageChannel | CategoryChannel`.
+- `channelType` is a discord.js `ChannelType`. Can be one of `GuildText | GuildVoice | GuildNews | GuildStageVoice | GuildCategory` (prepended with `ChannelType`).
+- It is intended that you pass in a type for `T` that matches `channelType`. The returned channel is cast as whatever type is passed in.
+- For example:
+
+```
+const someTextChannel = await getChannelByName<TextChannel>('some-text-channel', ChannelType.GuildText)
+```

package/dist/guildCache.d.ts

@@ -1,11 +1,11 @@
-import { Client, Guild } from 'discord.js';
+import { Client } from 'discord.js';
 declare function setBot(botClient: Client): void;
-declare function getGuildCache(baseGuild?: Guild): Promise<{
-    guild: Guild;
-    channels: import("@discordjs/collection").Collection<string, import("discord.js").NonThreadGuildBasedChannel>;
-    emojis: import("@discordjs/collection").Collection<string, import("discord.js").GuildEmoji>;
-    members: import("@discordjs/collection").Collection<string, import("discord.js").GuildMember>;
-    roles: import("@discordjs/collection").Collection<string, import("discord.js").Role>;
+declare function getGuildCache(): Promise<{
+    guild: import("discord.js").Guild;
+    channels: import("discord.js").Collection<string, import("discord.js").NonThreadGuildBasedChannel>;
+    emojis: import("discord.js").Collection<string, import("discord.js").GuildEmoji>;
+    members: import("discord.js").Collection<string, import("discord.js").GuildMember>;
+    roles: import("discord.js").Collection<string, import("discord.js").Role>;
 } | undefined>;
 export default getGuildCache;
 export { setBot };

package/dist/guildCache.js

@@ -2,13 +2,13 @@ let bot;
 function setBot(botClient) {
     bot = botClient;
 }
-async function getGuildCache(baseGuild) {
+async function getGuildCache() {
     if (!bot)
         return;
     const guilds = await bot.guilds.fetch();
     if (!guilds)
         return;
-    const guild = baseGuild ? await baseGuild.fetch() : await guilds.first()?.fetch();
+    const guild = await guilds.first()?.fetch();
     if (!guild)
         return;
     const channels = await guild.channels.fetch();

package/dist/guildCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"guildCache.js","sourceRoot":"","sources":["../src/guildCache.ts"],"names":[],"mappings":"AAEA,IAAI,GAAW,CAAA;AAEf,SAAS,MAAM,CAAC,SAAiB;IAC/B,GAAG,GAAG,SAAS,CAAA;AACjB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,SAAiB;IAC5C,IAAI,CAAC,GAAG;QAAE,OAAM;IAEhB,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IACvC,IAAI,CAAC,MAAM;QAAE,OAAM;IACnB,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAA;IACjF,IAAI,CAAC,KAAK;QAAE,OAAM;IAElB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAA;IAC7C,IAAI,CAAC,QAAQ;QAAE,OAAM;IAErB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IACzC,IAAI,CAAC,MAAM;QAAE,OAAM;IAEnB,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;IAC3C,IAAI,CAAC,OAAO;QAAE,OAAM;IAEpB,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;IACvC,IAAI,CAAC,KAAK;QAAE,OAAM;IAElB,OAAO;QACL,KAAK;QACL,QAAQ;QACR,MAAM;QACN,OAAO;QACP,KAAK;KACN,CAAA;AACH,CAAC;AAED,eAAe,aAAa,CAAA;AAC5B,OAAO,EAAE,MAAM,EAAE,CAAA"}
+{"version":3,"file":"guildCache.js","sourceRoot":"","sources":["../src/guildCache.ts"],"names":[],"mappings":"AAEA,IAAI,GAAW,CAAA;AAEf,SAAS,MAAM,CAAC,SAAiB;IAC/B,GAAG,GAAG,SAAS,CAAA;AACjB,CAAC;AAED,KAAK,UAAU,aAAa;IAC1B,IAAI,CAAC,GAAG;QAAE,OAAM;IAEhB,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IACvC,IAAI,CAAC,MAAM;QAAE,OAAM;IACnB,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAA;IAC3C,IAAI,CAAC,KAAK;QAAE,OAAM;IAElB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAA;IAC7C,IAAI,CAAC,QAAQ;QAAE,OAAM;IAErB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IACzC,IAAI,CAAC,MAAM;QAAE,OAAM;IAEnB,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;IAC3C,IAAI,CAAC,OAAO;QAAE,OAAM;IAEpB,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;IACvC,IAAI,CAAC,KAAK;QAAE,OAAM;IAElB,OAAO;QACL,KAAK;QACL,QAAQ;QACR,MAAM;QACN,OAAO;QACP,KAAK;KACN,CAAA;AACH,CAAC;AAED,eAAe,aAAa,CAAA;AAC5B,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/dist/index.d.ts

@@ -5,4 +5,4 @@ export default login;
 export { Command } from './commands.js';
 export { default as getGuildCache } from './guildCache.js';
 export { InteractionCheck } from './interactionCreate.js';
-export { isCategoryChannel, isTextChannel, throwError } from './util.js';
+export { getChannelByName, throwError } from './util.js';

package/dist/index.js

@@ -19,5 +19,5 @@ async function login(botIntents, projectMetaURL, interactionCheck) {
 }
 export default login;
 export { default as getGuildCache } from './guildCache.js';
-export { isCategoryChannel, isTextChannel, throwError } from './util.js';
+export { getChannelByName, throwError } from './util.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,YAAY,CAAA;AAClD,OAAO,gBAAgB,MAAM,eAAe,CAAA;AAC5C,OAAO,cAAc,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,yBAA+C,MAAM,wBAAwB,CAAA;AACpF,OAAO,aAAa,MAAM,YAAY,CAAA;AAEtC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAA;AAC5C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAA;AAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAA;AAE1C,KAAK,UAAU,KAAK,CAClB,UAAyB,EACzB,cAAsB,EACtB,gBAAmC;IAEnC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;IAClC,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;IAEpF,aAAa,CAAC,GAAG,CAAC,CAAA;IAClB,yBAAyB,CAAC,GAAG,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IAC1D,KAAK,cAAc,CAAC,cAAc,CAAC,CAAA;IAEnC,MAAM,CAAC,GAAG,CAAC,CAAA;IAEX,KAAK,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;IACxB,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,eAAe,KAAK,CAAA;AAEpB,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE1D,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,YAAY,CAAA;AAClD,OAAO,gBAAgB,MAAM,eAAe,CAAA;AAC5C,OAAO,cAAc,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,yBAA+C,MAAM,wBAAwB,CAAA;AACpF,OAAO,aAAa,MAAM,YAAY,CAAA;AAEtC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAA;AAC5C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAA;AAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAA;AAE1C,KAAK,UAAU,KAAK,CAAC,UAAyB,EAAE,cAAsB,EAAE,gBAAmC;IACzG,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAA;IAClC,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;IAEpF,aAAa,CAAC,GAAG,CAAC,CAAA;IAClB,yBAAyB,CAAC,GAAG,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IAC1D,KAAK,cAAc,CAAC,cAAc,CAAC,CAAA;IAEnC,MAAM,CAAC,GAAG,CAAC,CAAA;IAEX,KAAK,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;IACxB,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,eAAe,KAAK,CAAA;AAEpB,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE1D,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA"}

package/dist/interactionCreate.js

@@ -26,7 +26,7 @@ async function checkRoles(command, interaction) {
         const member = await interaction.guild?.members.fetch(interaction.user).catch(console.error);
         if (!member)
             return;
-        return member.roles.cache.some((role) => command.requiredRoles ? command.requiredRoles.includes(role.name) : false);
+        return member.roles.cache.some((role) => (command.requiredRoles ? command.requiredRoles.includes(role.name) : false));
     }
     return false;
 }

package/dist/interactionCreate.js.map

@@ -1 +1 @@
-{"version":3,"file":"interactionCreate.js","sourceRoot":"","sources":["../src/interactionCreate.ts"],"names":[],"mappings":"AAKA,SAAS,yBAAyB,CAAC,GAAW,EAAE,QAA4B,EAAE,gBAAmC;IAC/G,GAAG,CAAC,EAAE,CAAC,mBAAmB,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;QAChD,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE;YAAE,OAAM;QAE7C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;QACrD,IAAI,CAAC,OAAO;YAAE,OAAO,gBAAgB,CAAC,WAAW,EAAE,wBAAwB,CAAC,CAAA;QAE5E,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAC3C,OAAO,gBAAgB,CAAC,WAAW,EAAE,gEAAgE,CAAC,CAAA;QAExG,IAAI;YACF,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,CAAC,CAAC,MAAM,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YAC5F,IAAI,CAAC,sBAAsB;gBAAE,OAAM;YAEnC,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;SAC/B;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;YAChE,gBAAgB,CAAC,WAAW,EAAE,mDAAmD,YAAY,EAAE,CAAC,CAAA;SACjG;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,OAAgB,EAAE,WAAwC;IAClF,IAAI,CAAC,OAAO,CAAC,aAAa;QAAE,OAAO,IAAI,CAAA;IAEvC,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QACpC,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC5F,IAAI,CAAC,MAAM;YAAE,OAAM;QAEnB,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACtC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAC1E,CAAA;KACF;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,gBAAgB,CAAC,WAAwC,EAAE,OAAe;IACjF,WAAW,CAAC,QAAQ;QAClB,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAC1D,CAAC,CAAC,KAAK,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AACxF,CAAC;AAED,eAAe,yBAAyB,CAAA"}
+{"version":3,"file":"interactionCreate.js","sourceRoot":"","sources":["../src/interactionCreate.ts"],"names":[],"mappings":"AAKA,SAAS,yBAAyB,CAAC,GAAW,EAAE,QAA4B,EAAE,gBAAmC;IAC/G,GAAG,CAAC,EAAE,CAAC,mBAAmB,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;QAChD,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE;YAAE,OAAM;QAE7C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;QACrD,IAAI,CAAC,OAAO;YAAE,OAAO,gBAAgB,CAAC,WAAW,EAAE,wBAAwB,CAAC,CAAA;QAE5E,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAC3C,OAAO,gBAAgB,CAAC,WAAW,EAAE,gEAAgE,CAAC,CAAA;QAExG,IAAI;YACF,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,CAAC,CAAC,MAAM,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YAC5F,IAAI,CAAC,sBAAsB;gBAAE,OAAM;YAEnC,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;SAC/B;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;YAChE,gBAAgB,CAAC,WAAW,EAAE,mDAAmD,YAAY,EAAE,CAAC,CAAA;SACjG;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,OAAgB,EAAE,WAAwC;IAClF,IAAI,CAAC,OAAO,CAAC,aAAa;QAAE,OAAO,IAAI,CAAA;IAEvC,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QACpC,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC5F,IAAI,CAAC,MAAM;YAAE,OAAM;QAEnB,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;KACtH;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,gBAAgB,CAAC,WAAwC,EAAE,OAAe;IACjF,WAAW,CAAC,QAAQ;QAClB,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAC1D,CAAC,CAAC,KAAK,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AACxF,CAAC;AAED,eAAe,yBAAyB,CAAA"}

package/dist/util.d.ts

@@ -1,5 +1,5 @@
-import { APIPartialChannel, BaseChannel, CategoryChannel, TextChannel } from 'discord.js';
-declare function isTextChannel(channel: BaseChannel | APIPartialChannel): channel is TextChannel;
-declare function isCategoryChannel(channel: BaseChannel): channel is CategoryChannel;
+import { ChannelType, NonThreadGuildBasedChannel } from 'discord.js';
+declare type NonThreadGuildBasedChannelType = ChannelType.GuildText | ChannelType.GuildVoice | ChannelType.GuildNews | ChannelType.GuildStageVoice | ChannelType.GuildCategory;
+declare function getChannelByName<T extends NonThreadGuildBasedChannel>(channelName: string, channelType: NonThreadGuildBasedChannelType): Promise<T | undefined>;
 declare function throwError(error: string): never;
-export { isTextChannel, isCategoryChannel, throwError };
+export { getChannelByName, throwError };

package/dist/util.js

@@ -1,12 +1,11 @@
-import { ChannelType } from 'discord.js';
-function isTextChannel(channel) {
-    return channel.type === ChannelType.GuildText;
-}
-function isCategoryChannel(channel) {
-    return channel.type === ChannelType.GuildCategory;
+import getGuildCache from './guildCache.js';
+async function getChannelByName(channelName, channelType) {
+    const { channels } = (await getGuildCache()) || throwError('Unable to get guild cache.');
+    const channel = channels.find((channel) => channel.name === channelName);
+    return channel && channel.type === channelType ? channel : undefined;
 }
 function throwError(error) {
     throw new Error(error);
 }
-export { isTextChannel, isCategoryChannel, throwError };
+export { getChannelByName, throwError };
 //# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -1 +1 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmD,WAAW,EAAe,MAAM,YAAY,CAAA;AAEtG,SAAS,aAAa,CAAC,OAAwC;IAC7D,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,CAAA;AAC/C,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAoB;IAC7C,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,aAAa,CAAA;AACnD,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;AACxB,CAAC;AAED,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,UAAU,EAAE,CAAA"}
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAS3C,KAAK,UAAU,gBAAgB,CAC7B,WAAmB,EACnB,WAA2C;IAE3C,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,aAAa,EAAE,CAAC,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAA;IACxF,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAA;IAExE,OAAO,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAE,OAAa,CAAC,CAAC,CAAC,SAAS,CAAA;AAC7E,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAA;AACxB,CAAC;AAED,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-bot-shared",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "type": "module",
   "description": "Modules for creating discord bots.",
   "repository": "github:adamhl8/discord-bot-shared",
@@ -18,26 +18,26 @@
     "lint": "eslint -f pretty --fix ."
   },
   "dependencies": {
-    "@discordjs/rest": "^1.0.0",
-    "discord-api-types": "^0.36.3",
-    "discord.js": "^14.0.3"
+    "@discordjs/rest": "^1.0.1",
+    "discord-api-types": "^0.37.3",
+    "discord.js": "^14.2.0"
   },
   "devDependencies": {
-    "@types/eslint": "^8.4.5",
-    "@types/node": "^18.6.1",
-    "@types/prettier": "^2.6.3",
-    "@typescript-eslint/eslint-plugin": "^5.31.0",
-    "@typescript-eslint/parser": "^5.31.0",
-    "eslint": "^8.20.0",
+    "@types/eslint": "^8.4.6",
+    "@types/node": "^18.7.9",
+    "@types/prettier": "^2.7.0",
+    "@typescript-eslint/eslint-plugin": "^5.33.1",
+    "@typescript-eslint/parser": "^5.33.1",
+    "eslint": "^8.22.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-formatter-pretty": "^4.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-sonarjs": "^0.14.0",
+    "eslint-plugin-sonarjs": "^0.15.0",
     "eslint-plugin-unicorn": "^43.0.2",
     "prettier": "^2.7.1",
-    "prettier-plugin-organize-imports": "^3.0.0",
-    "prettier-plugin-pkg": "^0.16.0",
-    "prettier-plugin-sh": "^0.12.6",
+    "prettier-plugin-organize-imports": "^3.1.0",
+    "prettier-plugin-pkg": "^0.17.0",
+    "prettier-plugin-sh": "^0.12.8",
     "typescript": "^4.7.4"
   }
 }