@magicyan/discord 1.0.7 → 1.0.9

package/README.md

@@ -92,4 +92,18 @@ new EmbedBuilder({
     author: createEmbedAuthor({ user }),
     description: "My embed description"
 })
+```
+
+Function to find a channel from the guild cache
+```ts
+const { guild } = interaction
+
+const channel = findChannel(guild, ChannelType.GuildVoice).byName("Lounge 01") // VoiceChannel  | undefined
+```
+
+Function to find a role from the guild cache
+```ts
+const { guild } = interaction
+
+const role = findChannel(guild).byName("Administrator") // Role  | undefined
 ```

package/dist/functions/channels.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findChannel = void 0;
+const discord_js_1 = require("discord.js");
+function findChannel(guild, type) {
+    const channelType = type || discord_js_1.ChannelType.GuildText;
+    return {
+        byName(name) {
+            return guild.channels.cache.find(c => c.name === name && c.type === channelType);
+        },
+        byId(id) {
+            return guild.channels.cache.find(c => c.id === id && c.type === channelType);
+        }
+    };
+}
+exports.findChannel = findChannel;

package/dist/functions/embeds.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createEmbedAuthor = void 0;
-function createEmbedAuthor({ user, property = "displayName", imageSize: size = 512, iconURL, url, prefix = "", suffix = "" }) {
+function createEmbedAuthor(options) {
+    const { user, property = "displayName", imageSize: size = 512, iconURL, url, prefix = "", suffix = "" } = options;
     return {
         name: `${prefix}${user[property]}${suffix}`, url,
         iconURL: iconURL || user.displayAvatarURL({ size })

package/dist/functions/roles.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findRole = void 0;
+function findRole(guild) {
+    return {
+        byName(name) {
+            return guild.roles.cache.find(role => role.name == name);
+        },
+        byId(id) {
+            return guild.roles.cache.get(id);
+        }
+    };
+}
+exports.findRole = findRole;

package/dist/index.js

@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./constants/client"), exports);
-__exportStar(require("./functions/utils"), exports);
+__exportStar(require("./functions/channels"), exports);
 __exportStar(require("./functions/embeds"), exports);
+__exportStar(require("./functions/roles"), exports);
+__exportStar(require("./functions/utils"), exports);
 __exportStar(require("@magicyan/core"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magicyan/discord",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "publishConfig": {
     "access": "public"
   },
@@ -28,9 +28,9 @@
   "homepage": "https://github.com/rinckodev/magicyan/tree/main/packages/discord#readme",
   "description": "Simple functions to facilitate discord bot development",
   "dependencies": {
-    "@magicyan/core": "^1.0.8"
+    "@magicyan/core": "^1.0.9"
   },
   "peerDependencies": {
-    "discord.js": "^14.13.0"
+    "discord.js": "^14.14.1"
   }
 }

package/types/functions/channels.d.ts

@@ -0,0 +1,10 @@
+import type { CommandInteractionOption, Guild } from "discord.js";
+import { ChannelType } from "discord.js";
+type GetChannelType<Type extends ChannelType> = Extract<NonNullable<CommandInteractionOption<"cached">["channel"]>, {
+    type: Type extends ChannelType.PublicThread | ChannelType.AnnouncementThread ? ChannelType.PublicThread | ChannelType.AnnouncementThread : Type;
+}>;
+export declare function findChannel<Type extends Exclude<ChannelType, ChannelType.DM> = ChannelType.GuildText>(guild: Guild, type?: Type): {
+    byName(name: string): GetChannelType<Type> | undefined;
+    byId(id: string): GetChannelType<Type> | undefined;
+};
+export {};

package/types/functions/embeds.d.ts

@@ -1,10 +1,12 @@
-import { EmbedAuthorData, ImageURLOptions, User } from "discord.js";
-export declare function createEmbedAuthor({ user, property, imageSize: size, iconURL, url, prefix, suffix }: {
+import type { EmbedAuthorData, ImageURLOptions, User } from "discord.js";
+interface CreateEmbedAuthorOptions {
     user: User;
-    property?: keyof Pick<User, "username" | "displayName" | "id">;
+    property?: "username" | "displayName" | "id" | "globalName";
     imageSize?: ImageURLOptions["size"];
     iconURL?: string;
     url?: string;
     prefix?: string;
     suffix?: string;
-}): EmbedAuthorData;
+}
+export declare function createEmbedAuthor(options: CreateEmbedAuthorOptions): EmbedAuthorData;
+export {};

package/types/functions/roles.d.ts

@@ -0,0 +1,5 @@
+import type { Guild } from "discord.js";
+export declare function findRole(guild: Guild): {
+    byName(name: string): import("discord.js").Role | undefined;
+    byId(id: string): import("discord.js").Role | undefined;
+};

package/types/functions/utils.d.ts

@@ -1,4 +1,7 @@
-import { ActionRowBuilder, AnyComponentBuilder, ButtonBuilder, LinkButtonComponentData, TextInputBuilder, TextInputComponentData } from "discord.js";
+import type { AnyComponentBuilder, LinkButtonComponentData, TextInputComponentData } from "discord.js";
+import { ActionRowBuilder, TextInputBuilder, ButtonBuilder } from "discord.js";
 export declare function createRow<Component extends AnyComponentBuilder>(...components: Component[]): ActionRowBuilder<Component>;
 export declare function createModalInput(data: Omit<TextInputComponentData, "type">): ActionRowBuilder<TextInputBuilder>;
-export declare function createLinkButton(data: Omit<LinkButtonComponentData, "style" | "type">): ButtonBuilder;
+type CreateLinkButtonData = Omit<LinkButtonComponentData, "style" | "type">;
+export declare function createLinkButton(data: CreateLinkButtonData): ButtonBuilder;
+export {};

package/types/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./constants/client";
-export * from "./functions/utils";
+export * from "./functions/channels";
 export * from "./functions/embeds";
+export * from "./functions/roles";
+export * from "./functions/utils";
 export * from "@magicyan/core";