@magicyan/discord 1.0.9 → 1.0.11

package/README.md

@@ -106,4 +106,23 @@ Function to find a role from the guild cache
 const { guild } = interaction
 
 const role = findChannel(guild).byName("Administrator") // Role  | 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
+```ts
+const embed = new EmbedBuilder({
+    image: createEmbedAsset(guild.iconURL()) // { url: guild.iconUrl() } | undefined
+})
+```
+
+When passing an attachment to the function, it will return the url with local attachments
+```ts
+const image = new AttachmentBuilder(buffer, { name: "myImage.png" });
+
+const embed = new EmbedBuilder({
+    image: createEmbedAsset(image) // { url: attachment://myImage.png }
+});
+
+channel.send({ embeds: [embed], files: [image]})
 ```

package/dist/functions/channels.js

@@ -6,10 +6,10 @@ 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);
+            return guild.channels.cache.find(channel => channel.name === name && channel.type === channelType);
         },
         byId(id) {
-            return guild.channels.cache.find(c => c.id === id && c.type === channelType);
+            return guild.channels.cache.find(channel => channel.id === id && channel.type === channelType);
         }
     };
 }

package/dist/functions/embeds.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createEmbedAuthor = void 0;
+exports.createEmbed = exports.createEmbedAsset = exports.createEmbedAuthor = void 0;
+const discord_js_1 = require("discord.js");
 function createEmbedAuthor(options) {
     const { user, property = "displayName", imageSize: size = 512, iconURL, url, prefix = "", suffix = "" } = options;
     return {
@@ -9,3 +10,27 @@ function createEmbedAuthor(options) {
     };
 }
 exports.createEmbedAuthor = createEmbedAuthor;
+function createEmbedAsset(source, options) {
+    if (source instanceof discord_js_1.Attachment || source instanceof discord_js_1.AttachmentBuilder) {
+        return { url: `attachment://${source.name}`, ...options };
+    }
+    return source ? { url: source, ...options } : undefined;
+}
+exports.createEmbedAsset = createEmbedAsset;
+function createEmbed(options) {
+    const { extend: extendRaw = {}, ...embedRaw } = options;
+    const { color: embedColor, modify, ...embedData } = embedRaw;
+    const { color: extendColor, ...extendData } = extendRaw;
+    const data = { ...extendData, ...embedData };
+    const builder = new discord_js_1.EmbedBuilder(data);
+    if (extendColor)
+        builder.setColor(extendColor);
+    if (embedColor)
+        builder.setColor(embedColor);
+    if (modify?.fields && typeof modify.fields == "function") {
+        const fields = modify.fields(builder.data.fields || []);
+        builder.setFields(fields);
+    }
+    return builder;
+}
+exports.createEmbed = createEmbed;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magicyan/discord",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "publishConfig": {
     "access": "public"
   },

package/types/functions/embeds.d.ts

@@ -1,4 +1,4 @@
-import type { EmbedAuthorData, ImageURLOptions, User } from "discord.js";
+import { EmbedAuthorData, EmbedBuilder, ImageURLOptions, User, EmbedAssetData, Attachment, AttachmentBuilder, ColorResolvable, EmbedFooterData } from "discord.js";
 interface CreateEmbedAuthorOptions {
     user: User;
     property?: "username" | "displayName" | "id" | "globalName";
@@ -9,4 +9,32 @@ interface CreateEmbedAuthorOptions {
     suffix?: string;
 }
 export declare function createEmbedAuthor(options: CreateEmbedAuthorOptions): EmbedAuthorData;
+type EmbedAssetOptions = Omit<EmbedAssetData, "url">;
+type AssetSource = string | null | Attachment | AttachmentBuilder;
+export declare function createEmbedAsset(source?: AssetSource, options?: EmbedAssetOptions): EmbedAssetData | undefined;
+type EmbedColor = ColorResolvable | (string & {});
+type BaseEmbedField = {
+    name: string;
+    value: string;
+    inline?: boolean;
+};
+type BaseEmbedData = {
+    title?: string;
+    color?: EmbedColor;
+    description?: string;
+    url?: string;
+    timestamp?: string | number | Date;
+    footer?: EmbedFooterData;
+    image?: EmbedAssetData;
+    thumbnail?: EmbedAssetData;
+    author?: EmbedAuthorData;
+    fields?: BaseEmbedField[];
+};
+type CreateEmbedOptions = BaseEmbedData & {
+    extend?: BaseEmbedData;
+    modify?: {
+        fields?(fields: BaseEmbedField[]): BaseEmbedField[];
+    };
+};
+export declare function createEmbed(options: CreateEmbedOptions): EmbedBuilder;
 export {};

package/types/functions/utils.d.ts

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