discord-bot-shared 0.4.0 → 0.5.1

package/README.md

@@ -132,13 +132,13 @@ interface Command {
 
 ---
 
-#### `function getChannelByName`
+#### `function getChannel`
 
-Returns a guild channel of the given name and type, otherwise returns `undefined`.
+Returns the guild channel of the given name/ID and type, otherwise returns `undefined`.
 
 ```
-async function getChannelByName<T extends NonThreadGuildBasedChannel>(
-  channelName: string,
+async function getChannel<T extends NonThreadGuildBasedChannel>(
+  channelNameOrId: string,
   channelType: NonThreadGuildBasedChannelType,
 ): Promise<T | undefined>
 ```
@@ -149,5 +149,21 @@ async function getChannelByName<T extends NonThreadGuildBasedChannel>(
 - For example:
 
 ```
-const someTextChannel = await getChannelByName<TextChannel>('some-text-channel', ChannelType.GuildText)
+const someTextChannel = await getChannel<TextChannel>('some-text-channel', ChannelType.GuildText)
 ```
+
+---
+
+#### Channel Type Guards
+
+These are channel type guards that you may need to use.
+
+```
+function isTextChannel(channel: BaseChannel | APIPartialChannel): channel is TextChannel
+```
+
+```
+function isCategoryChannel(channel: BaseChannel): channel is CategoryChannel
+```
+
+- Almost every channel type in discord.js extends `BaseChannel`, so you should be able to pass in whatever channel you need to here.

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 { getChannelByName, throwError } from './util.js';
+export { getChannel, isCategoryChannel, isTextChannel, 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 { getChannelByName, throwError } from './util.js';
+export { getChannel, isCategoryChannel, isTextChannel, 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,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"}
+{"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,UAAU,EAAE,iBAAiB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA"}

package/dist/util.d.ts

@@ -1,5 +1,7 @@
-import { ChannelType, NonThreadGuildBasedChannel } from 'discord.js';
+import { APIPartialChannel, BaseChannel, CategoryChannel, ChannelType, NonThreadGuildBasedChannel, TextChannel } 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 getChannel<T extends NonThreadGuildBasedChannel>(channelNameOrId: string, channelType: NonThreadGuildBasedChannelType): Promise<T | undefined>;
+declare function isTextChannel(channel: BaseChannel | APIPartialChannel): channel is TextChannel;
+declare function isCategoryChannel(channel: BaseChannel): channel is CategoryChannel;
 declare function throwError(error: string): never;
-export { getChannelByName, throwError };
+export { getChannel, isTextChannel, isCategoryChannel, throwError };

package/dist/util.js

@@ -1,11 +1,23 @@
+import { ChannelType } from 'discord.js';
 import getGuildCache from './guildCache.js';
-async function getChannelByName(channelName, channelType) {
+async function getChannel(channelNameOrId, 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;
+    let channel;
+    channel = channels.find((channel) => channel.name === channelNameOrId);
+    if (channel)
+        return channel.type === channelType ? channel : undefined;
+    channel = channels.get(channelNameOrId);
+    if (channel)
+        return channel.type === channelType ? channel : undefined;
+}
+function isTextChannel(channel) {
+    return channel.type === ChannelType.GuildText;
+}
+function isCategoryChannel(channel) {
+    return channel.type === ChannelType.GuildCategory;
 }
 function throwError(error) {
     throw new Error(error);
 }
-export { getChannelByName, throwError };
+export { getChannel, isTextChannel, isCategoryChannel, throwError };
 //# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmD,WAAW,EAA2C,MAAM,YAAY,CAAA;AAClI,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAS3C,KAAK,UAAU,UAAU,CACvB,eAAuB,EACvB,WAA2C;IAE3C,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,aAAa,EAAE,CAAC,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAA;IAExF,IAAI,OAA+C,CAAA;IACnD,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,eAAe,CAAC,CAAA;IACtE,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAE,OAAa,CAAC,CAAC,CAAC,SAAS,CAAA;IAE7E,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;IACvC,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAE,OAAa,CAAC,CAAC,CAAC,SAAS,CAAA;AAC/E,CAAC;AAED,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,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAE,UAAU,EAAE,CAAA"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "discord-bot-shared",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "type": "module",
   "description": "Modules for creating discord bots.",
   "repository": "github:adamhl8/discord-bot-shared",
   "author": "adamhl8",
   "license": "MIT",
-  "main": "dist/index",
+  "main": "dist/index.js",
   "files": [
     "dist/",
     "README.md",
@@ -15,29 +15,29 @@
   "scripts": {
     "build": "tsc",
     "format": "prettier --write .",
-    "lint": "eslint -f pretty --fix ."
+    "lint": "eslint -f pretty"
   },
   "dependencies": {
-    "@discordjs/rest": "^1.0.1",
-    "discord-api-types": "^0.37.3",
-    "discord.js": "^14.2.0"
+    "@discordjs/rest": "^1.1.0",
+    "discord-api-types": "^0.37.9",
+    "discord.js": "^14.3.0"
   },
   "devDependencies": {
     "@types/eslint": "^8.4.6",
-    "@types/node": "^18.7.9",
+    "@types/node": "^18.7.16",
     "@types/prettier": "^2.7.0",
-    "@typescript-eslint/eslint-plugin": "^5.33.1",
-    "@typescript-eslint/parser": "^5.33.1",
-    "eslint": "^8.22.0",
+    "@typescript-eslint/eslint-plugin": "^5.37.0",
+    "@typescript-eslint/parser": "^5.37.0",
+    "eslint": "^8.23.1",
     "eslint-config-prettier": "^8.5.0",
     "eslint-formatter-pretty": "^4.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-sonarjs": "^0.15.0",
     "eslint-plugin-unicorn": "^43.0.2",
     "prettier": "^2.7.1",
-    "prettier-plugin-organize-imports": "^3.1.0",
-    "prettier-plugin-pkg": "^0.17.0",
+    "prettier-plugin-organize-imports": "^3.1.1",
+    "prettier-plugin-pkg": "^0.17.1",
     "prettier-plugin-sh": "^0.12.8",
-    "typescript": "^4.7.4"
+    "typescript": "^4.8.3"
   }
 }