@magicyan/discord 1.0.27 → 1.0.29

package/README.md

@@ -16,121 +16,268 @@ Install with
 npm install @magicyan/discord
 ```
 
-Some functions summarize the way we create things with discord.js
+## Components
+Easily create action rows
 
 ```ts
-// Create an action row of buttons with discord.js
-new ActionRowBuilder<ButtonBuilder>({
-    components: [
-        new ButtonBuilder({
-            customId: "click-me-button",
-            label: "Click me", style: ButtonStyle.Success,
-        })
-        new ButtonBuilder({
-            customId: "dont-click-me-button",
-            label: "Don't click me", style: ButtonStyle.Danger,
-        })
-    ]
-})
+import { createRow } from "@magicyan/discord";
 
-// Create an action row of buttons with @magicyan/dicord
-createRow(
-    new ButtonBuilder({ 
-        customId: "click-me-button", label: "Click me", 
-        style: ButtonStyle.Success,
-    })
-    new ButtonBuilder({ 
-        customId: "dont-click-me-button", label: "Don't click me", 
-        style: ButtonStyle.Danger,
-    })
-)
+const row = createRow(
+    new ButtonBuilder(/* button data... */),
+    new ButtonBuilder(/* button data... */),
+    new ButtonBuilder(/* button data... */),
+);
+const selectRow = createRow(
+    new StringSelectMenuBuilder(/* select data... */)
+);
+interaction.reply({ components: [row, selectRow] });
+```
+Create a link button quickly
+```ts
+import { createRow, createLinkButton } from "@magicyan/discord";
 
-// Add inputs to the modal with discord.js
-new ModalBuilder({
-    customId: "my-modal",
-    title: "Modal Title",
-    components: [
-        new ActionRowBuilder<TextInputBuilder>({components: [
-            new TextInputBuilder({
-                customId: "name-input",
-                label: "Name",
-                placeholder: "Enter your name",
-                style: TextInputStyle.Short,
-                required: true
-            }),
-            new TextInputBuilder({
-                customId: "nio-modal",
-                label: "Bio",
-                placeholder: "Enter your bio",
-                style: TextInputStyle.Paragraph,
-                required: true
-            })
-        ]})
-    ]
-})
+const row = createRow(
+    createLinkButton({ label: "Github", url: "https://github.com/rinckodev" })
+    createLinkButton({ label: "Youtube", url: "https://youtube.com/@rinckodev" })
+);
+interaction.reply({ components: [row] });
+```
 
-// Add inputs to the modal with @magicyan/dicord
-new ModalBuilder({
-    customId: "my-modal", title: "Modal Title",
+## Modals
+A row only supports a single input, so use this function that already creates it within a row
+```ts
+import { createModalInput } from "@magicyan/discord";
+
+const modal = new ModalBuilder({
+    customId: "my/modal",
+    title: "My modal",
     components: [
         createModalInput({
-            customId: "name-input", placeholder: "Enter your name",
-            label: "Name", style: TextInputStyle.Short, required: true
+            customId: "name",
+            label: "Name",
+            style: TextInputStyle.Short,
         }),
         createModalInput({
-            customId: "nio-modal", placeholder: "Enter your bio",
-            label: "Bio", style: TextInputStyle.Paragraph, required: true
+            customId: "age",
+            label: "Age",
+            style: TextInputStyle.Short,
         }),
     ]
+});
+interaction.showModal(modal);
+```
+Or if you prefer, you can create a record where the key is the customId
+```ts
+import { createModalFields } from "@magicyan/discord";
+
+const modal = new ModalBuilder({
+    customId: "my/modal",
+    title: "My modal",
+    components: createModalFields({
+        name: {
+            label: "Name",
+            style: TextInputStyle.Short,
+        },
+        age:{
+            label: "Age",
+            style: TextInputStyle.Short,
+        },
+    })
+});
+```
+Don't forget that you can define the custom id however you want
+```ts
+createModalFields({
+    ["my-custom-input-name"]: {
+        label: "Name",
+        style: TextInputStyle.Short,
+    }
 })
 ```
+You can transform the fields received from the interaction into a record
+```ts
+import { modalFieldsToRecord } from "@magicyan/discord";
 
-You can create a link button quickly
+function run(interaction: ModalSubmitInteraction){
+    const fields = modalFieldsToRecord(interaction.fields);
+    console.log(fields["my-custom-input-name"]);
+    console.log(fields.age);
+}
+```
+It is also possible to pass a union type in the function generic
+```ts
+type FormFields = "id" | "nickname" | "bio";
+function run(interaction: ModalSubmitInteraction){
+    const fields = modalFieldsToRecord<FormFields>(interaction.fields);
+    console.log(fields.id);
+    console.log(fields.nickname);
+    console.log(fields.bio);
+}
+```
+
+## Embeds
+Easily create embeds with this function
+```ts
+const embed = createEmbed({
+    title: "Welcome",
+    description: "Hello world",
+    color: "Random"
+});
+```
+You can set the thumbnail and image in a simple way
+```ts
+const embed = createEmbed({
+    // ...
+    thumbnail: "https://github.com/rinckodev.png",
+    image: guild.iconURL()
+});
+
+// Or passing an options object
+const embed = createEmbed({
+    // ...
+    image: { url: "imageurl", width: 400, height: 100 }
+});
+
+//Or passing an attachment
+const attachment = new AttachmentBuilder(buffer, { name: "myimage.png" });
+const embed = createEmbed({
+    // ...
+    image: attachment // attachment://myimage.png
+});
+```
+
+## Channels
+You can try to get information from a channel url
+```ts
+import { getChannelUrlInfo } from "@magicyan/discord";
+
+const url = "https://discord.com/channels/537817462272557057/832829213651763210";
+const { guildId, channelId } = getChannelUrlInfo(url);
+console.log(guildId); // 537817462272557057
+console.log(channelId); // 832829213651763210
+```
+If the url does not follow the pattern of a discord channel url, the return will be an empty object
 ```ts
 const url = "https://github.com/rinckodev";
+const { guildId, channelId } = getChannelUrlInfo(url);
+console.log(guildId); // undefined
+console.log(channelId); // undefined
+```
+Find a guild channel easily with the findChannel function
+```ts
+import { findChannel } from "@magicyan/discord";
 
-createLinkButton({ url, label: "My github" });
+function run(interaction: ChatInputCommandInteraction<"cached">){
+    const { guild } = interaction; 
+    const channel = findChannel(guild).byId("832829213651763210");
+    channel // TextChannel | undefined
+}
 ```
+This function searches for channels in the guild cache, by default it tries to find channels of the GuildText type, but you can change it to any type of guild channel
+```ts
+const channel = findChannel(guild, ChannelType.GuildVoice).byId("832829213651763210");
+// VoiceChannel | undefined
+```
+You can find channels in other ways
+```ts
+const general = findChannel(guild).byName("general");
+const updates = findChannel(guild, ChannelType.GuildAnnouncement).byName("updates");
+const lounge = findChannel(guild, ChannelType.GuildVoice).byName("Lounge 01");
+const popular = findChannel(guild, ChannelType.GuildStageVoice).byFilter(f => f.members.size >= 12);
+const hotforum = findChannel(guild, ChannelType.GuildForum).byFilter(f => f.threads.cache.size >= 100);
 
-You can create an embed author easily with a User object
+general; // TextChannel | undefined
+updates; // NewsChannel | undefined
+lounge; // VoiceChannel | undefined
+popular; // StageChannel | undefined
+hotforum; // ForumChannel | undefined
+```
+Find a channel in a category easily
 ```ts
-const { user } = interaction
+const ticket = findChannel(guild)
+    .inCategoryName("Tickets")
+    .byName(`ticket-${member.id}`);
 
-new EmbedBuilder({
-    author: createEmbedAuthor({ user }),
-    description: "My embed description"
-})
+ticket; // TextChannel | undefined
 ```
+## Roles
+Find guild roles easily
+```ts
+import { findRole } from "@magicyan/discord";
 
-Function to find a channel from the guild cache
+function run(interaction: ChatInputCommandInteraction<"cached">){
+    const { guild } = interaction; 
+    
+    const memberRole = findRole(guild).byName("Member");
+    const adminRole = findRole(guild).byHexColor("#ff5454");
+    const leaderRole = findRole(guild).byId("537818031728885771");
+    
+    memberRole // Role | undefined
+    adminRole // Role | undefined
+    leaderRole // Role | undefined
+}
+```
+## Members
+Find guild members easily
 ```ts
-const { guild } = interaction
+import { findMember } from "@magicyan/discord";
 
-const channel = findChannel(guild, ChannelType.GuildVoice).byName("Lounge 01") // VoiceChannel  | undefined
+function run(interaction: ChatInputCommandInteraction<"cached">){
+    const { guild } = interaction;
+    const finder = findMember(guild);
+    const member = finder.byId("264620632644255745")
+    ?? finder.byUsername("rincko")
+    ?? finder.byGlobalName("Rincko")
+    ?? finder.byNickname("RinckoZ_");
+
+    member; // GuildMember | undefined
+}
 ```
+## Messages
+You can try to get information from a channel url
+```ts
+import { getMessageUrlInfo } from "@magicyan/discord";
 
-Function to find a role from the guild cache
+const url = "https://discord.com/channels/537817462272557057/1101949941712171078/1101950570035691530";
+const { guildId, channelId, messageId } = getMessageUrlInfo(url);
+console.log(guildId); // 537817462272557057
+console.log(channelId); // 1101949941712171078
+console.log(messageId); // 1101950570035691530
+```
+## Commands
+Find a command easily
 ```ts
-const { guild } = interaction
+import { findCommand } from "@magicyan/discord";
 
-const role = findChannel(guild).byName("Administrator") // Role  | undefined
+function run(interaction: ChatInputCommandInteraction<"cached">){
+    const { client } = interaction;
+    const command = findCommand(client).byName("register");
+    command; // ApplicationCommand | undefined
+}
 ```
 
-Function to create embed asset
-If the method used to obtain a url returns null or undefined the function will set undefined in the image property
+## Emojis
+Find a emoji easily
 ```ts
-const embed = new EmbedBuilder({
-    image: createEmbedAsset(guild.iconURL()) // { url: guild.iconUrl() } | undefined
-})
+import { findEmoji } from "@magicyan/discord";
+
+function run(interaction: ChatInputCommandInteraction<"cached">){
+    const { client } = interaction;
+    const emoji = findEmoji(client).byName("discord");
+    emoji; // GuildEmoji | undefined
+}
 ```
 
-When passing an attachment to the function, it will return the url with local attachments
+## Regex
+Extract the id of any mention
 ```ts
-const image = new AttachmentBuilder(buffer, { name: "myImage.png" });
+import { extractMentionId } from "@magicyan/discord";
 
-const embed = new EmbedBuilder({
-    image: createEmbedAsset(image) // { url: attachment://myImage.png }
-});
+const user = "<@264620632644255745>";
+const channel = "<#1068689068256403457>";
+const role = "<@&929925182796226632>";
 
-channel.send({ embeds: [embed], files: [image]})
+extractMentionId(user) // 264620632644255745
+extractMentionId(channel) // 1068689068256403457
+extractMentionId(role) // 929925182796226632
 ```

package/dist/functions/channels.cjs

@@ -60,6 +60,9 @@ function findChannel(guild, type) {
   };
 }
 function getChannelUrlInfo(url) {
+  const regex = new RegExp(/^https:\/\/discord\.com\/channels\/\d+\/\d+$/);
+  if (!regex.test(url))
+    return {};
   const [channelId, guildId] = url.split("/").reverse();
   return { channelId, guildId };
 }

package/dist/functions/channels.mjs

@@ -58,6 +58,9 @@ function findChannel(guild, type) {
   };
 }
 function getChannelUrlInfo(url) {
+  const regex = new RegExp(/^https:\/\/discord\.com\/channels\/\d+\/\d+$/);
+  if (!regex.test(url))
+    return {};
   const [channelId, guildId] = url.split("/").reverse();
   return { channelId, guildId };
 }

package/dist/functions/components.cjs

@@ -10,55 +10,6 @@ function createLinkButton(data) {
     data.label = data.url;
   return new discord_js.ButtonBuilder({ style: discord_js.ButtonStyle.Link, ...data });
 }
-function createComponentsManager(components) {
-  const buttons = components.flatMap(
-    (row) => row.components.filter((c) => c.type === discord_js.ComponentType.Button)
-  );
-  const stringSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === discord_js.ComponentType.StringSelect)
-  );
-  const userSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === discord_js.ComponentType.UserSelect)
-  );
-  const channelSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === discord_js.ComponentType.ChannelSelect)
-  );
-  const roleSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === discord_js.ComponentType.RoleSelect)
-  );
-  const mentionableSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === discord_js.ComponentType.MentionableSelect)
-  );
-  return {
-    getButton(customId) {
-      return buttons.find((b) => b.customId === customId);
-    },
-    getStringSelect(customId) {
-      return stringSelects.find((b) => b.customId === customId);
-    },
-    getUserSelect(customId) {
-      return userSelects.find((b) => b.customId === customId);
-    },
-    getChannelSelect(customId) {
-      return channelSelects.find((b) => b.customId === customId);
-    },
-    getRoleSelect(customId) {
-      return roleSelects.find((b) => b.customId === customId);
-    },
-    getMentionableSelect(customId) {
-      return mentionableSelects.find((b) => b.customId === customId);
-    },
-    resolved: {
-      buttons,
-      stringSelects,
-      userSelects,
-      channelSelects,
-      roleSelects,
-      mentionableSelects
-    }
-  };
-}
 
-exports.createComponentsManager = createComponentsManager;
 exports.createLinkButton = createLinkButton;
 exports.createRow = createRow;

package/dist/functions/components.mjs

@@ -1,4 +1,4 @@
-import { ActionRowBuilder, ButtonBuilder, ButtonStyle, ComponentType } from 'discord.js';
+import { ActionRowBuilder, ButtonBuilder, ButtonStyle } from 'discord.js';
 
 function createRow(...components) {
   return new ActionRowBuilder({ components });
@@ -8,53 +8,5 @@ function createLinkButton(data) {
     data.label = data.url;
   return new ButtonBuilder({ style: ButtonStyle.Link, ...data });
 }
-function createComponentsManager(components) {
-  const buttons = components.flatMap(
-    (row) => row.components.filter((c) => c.type === ComponentType.Button)
-  );
-  const stringSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === ComponentType.StringSelect)
-  );
-  const userSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === ComponentType.UserSelect)
-  );
-  const channelSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === ComponentType.ChannelSelect)
-  );
-  const roleSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === ComponentType.RoleSelect)
-  );
-  const mentionableSelects = components.flatMap(
-    (row) => row.components.filter((c) => c.type === ComponentType.MentionableSelect)
-  );
-  return {
-    getButton(customId) {
-      return buttons.find((b) => b.customId === customId);
-    },
-    getStringSelect(customId) {
-      return stringSelects.find((b) => b.customId === customId);
-    },
-    getUserSelect(customId) {
-      return userSelects.find((b) => b.customId === customId);
-    },
-    getChannelSelect(customId) {
-      return channelSelects.find((b) => b.customId === customId);
-    },
-    getRoleSelect(customId) {
-      return roleSelects.find((b) => b.customId === customId);
-    },
-    getMentionableSelect(customId) {
-      return mentionableSelects.find((b) => b.customId === customId);
-    },
-    resolved: {
-      buttons,
-      stringSelects,
-      userSelects,
-      channelSelects,
-      roleSelects,
-      mentionableSelects
-    }
-  };
-}
 
-export { createComponentsManager, createLinkButton, createRow };
+export { createLinkButton, createRow };

package/dist/functions/embeds/assets.cjs

@@ -7,9 +7,9 @@ function createEmbedAsset(source, options) {
     return { url: `attachment://${source.name}`, ...options };
   }
   if (source && typeof source === "object" && "url" in source) {
-    return source;
+    return Object.assign(source, options ?? (options = {}));
   }
-  return source ? { url: source, ...options } : void 0;
+  return source ? Object.assign({ url: source }, options) : void 0;
 }
 
 exports.createEmbedAsset = createEmbedAsset;

package/dist/functions/embeds/assets.mjs

@@ -5,9 +5,9 @@ function createEmbedAsset(source, options) {
     return { url: `attachment://${source.name}`, ...options };
   }
   if (source && typeof source === "object" && "url" in source) {
-    return source;
+    return Object.assign(source, options ?? (options = {}));
   }
-  return source ? { url: source, ...options } : void 0;
+  return source ? Object.assign({ url: source }, options) : void 0;
 }
 
 export { createEmbedAsset };

package/dist/functions/embeds/author.cjs

@@ -1,30 +1,33 @@
 'use strict';
 
-function createEmbedAuthor(options) {
-  const { prefix = "", suffix = "", url, iconURL } = options;
-  const { size = 512, extension, forceStatic } = options;
-  const avatarOptions = { size, extension, forceStatic };
-  if ("member" in options) {
-    const { member, property: property2 = "displayName" } = options;
-    const name = {
-      id: member.id,
-      username: member.user.username,
-      displayName: member.displayName,
-      globalName: member.user.globalName,
-      nickname: member.nickname
-    }[property2] ?? member.displayName;
-    return {
-      name: `${prefix}${name}${suffix}`,
-      url,
-      iconURL: iconURL || member.displayAvatarURL(avatarOptions)
-    };
+const discord_js = require('discord.js');
+
+function createEmbedAuthor(type, options) {
+  const { prefix = "", suffix = "", url, iconURL: icon, extension, forceStatic, size = 1024 } = options ?? {};
+  let name = "";
+  let iconURL = icon;
+  const imageOptions = { extension, forceStatic, size };
+  switch (true) {
+    case type instanceof discord_js.User: {
+      const { property = "displayName" } = options ?? {};
+      name = type[property] ?? type.displayName;
+      iconURL = type.displayAvatarURL(imageOptions);
+      break;
+    }
+    case type instanceof discord_js.GuildMember: {
+      const { property = "displayName" } = options ?? {};
+      name = (property == "username" || property == "globalName" ? type.user[property] : type[property]) ?? type.displayName;
+      iconURL = type.displayAvatarURL(imageOptions);
+      break;
+    }
+    case type instanceof discord_js.Guild: {
+      const { property = "name" } = options ?? {};
+      name = type[property];
+      iconURL = type.iconURL(imageOptions) ?? void 0;
+      break;
+    }
   }
-  const { property = "displayName", user } = options;
-  return {
-    name: `${prefix}${options.user[property]}${suffix}`,
-    url,
-    iconURL: iconURL || user.displayAvatarURL(avatarOptions)
-  };
+  return { name: `${prefix}${name}${suffix}`, url: url ?? void 0, iconURL };
 }
 
 exports.createEmbedAuthor = createEmbedAuthor;

package/dist/functions/embeds/author.mjs

@@ -1,28 +1,31 @@
-function createEmbedAuthor(options) {
-  const { prefix = "", suffix = "", url, iconURL } = options;
-  const { size = 512, extension, forceStatic } = options;
-  const avatarOptions = { size, extension, forceStatic };
-  if ("member" in options) {
-    const { member, property: property2 = "displayName" } = options;
-    const name = {
-      id: member.id,
-      username: member.user.username,
-      displayName: member.displayName,
-      globalName: member.user.globalName,
-      nickname: member.nickname
-    }[property2] ?? member.displayName;
-    return {
-      name: `${prefix}${name}${suffix}`,
-      url,
-      iconURL: iconURL || member.displayAvatarURL(avatarOptions)
-    };
+import { Guild, GuildMember, User } from 'discord.js';
+
+function createEmbedAuthor(type, options) {
+  const { prefix = "", suffix = "", url, iconURL: icon, extension, forceStatic, size = 1024 } = options ?? {};
+  let name = "";
+  let iconURL = icon;
+  const imageOptions = { extension, forceStatic, size };
+  switch (true) {
+    case type instanceof User: {
+      const { property = "displayName" } = options ?? {};
+      name = type[property] ?? type.displayName;
+      iconURL = type.displayAvatarURL(imageOptions);
+      break;
+    }
+    case type instanceof GuildMember: {
+      const { property = "displayName" } = options ?? {};
+      name = (property == "username" || property == "globalName" ? type.user[property] : type[property]) ?? type.displayName;
+      iconURL = type.displayAvatarURL(imageOptions);
+      break;
+    }
+    case type instanceof Guild: {
+      const { property = "name" } = options ?? {};
+      name = type[property];
+      iconURL = type.iconURL(imageOptions) ?? void 0;
+      break;
+    }
   }
-  const { property = "displayName", user } = options;
-  return {
-    name: `${prefix}${options.user[property]}${suffix}`,
-    url,
-    iconURL: iconURL || user.displayAvatarURL(avatarOptions)
-  };
+  return { name: `${prefix}${name}${suffix}`, url: url ?? void 0, iconURL };
 }
 
 export { createEmbedAuthor };