@magicyan/discord 1.4.8 → 1.4.10

package/dist/functions/components/components.cjs

@@ -6,9 +6,10 @@ const selectmenu = require('../../guards/selectmenu.cjs');
 const gallery = require('./gallery.cjs');
 const row = require('./row.cjs');
 const text = require('./text.cjs');
+const core = require('@magicyan/core');
 
 function createComponents(...data) {
-  return data.flat().filter((value) => value !== null && value !== void 0).map((component) => {
+  return data.flat().filter((value) => core.isDefined(value)).filter((value) => typeof value !== "boolean").map((component) => {
     if (typeof component === "string") {
       return text.createTextDisplay(component);
     }

package/dist/functions/components/components.mjs

@@ -4,9 +4,10 @@ import { isAnySelectMenuBuilder } from '../../guards/selectmenu.mjs';
 import { createMediaGallery } from './gallery.mjs';
 import { createRow } from './row.mjs';
 import { createTextDisplay } from './text.mjs';
+import { isDefined } from '@magicyan/core';
 
 function createComponents(...data) {
-  return data.flat().filter((value) => value !== null && value !== void 0).map((component) => {
+  return data.flat().filter((value) => isDefined(value)).filter((value) => typeof value !== "boolean").map((component) => {
     if (typeof component === "string") {
       return createTextDisplay(component);
     }

package/dist/functions/components/thumbarea.cjs

@@ -0,0 +1,11 @@
+'use strict';
+
+const section = require('./section.cjs');
+const text = require('./text.cjs');
+
+function createThumbArea(argA, argB) {
+  const data = typeof argA === "string" ? { content: argA, thumbnail: argB } : argA;
+  return data.thumbnail ? section.createSection(data.content, data.thumbnail) : text.createTextDisplay(data.content);
+}
+
+exports.createThumbArea = createThumbArea;

package/dist/functions/components/thumbarea.mjs

@@ -0,0 +1,9 @@
+import { createSection } from './section.mjs';
+import { createTextDisplay } from './text.mjs';
+
+function createThumbArea(argA, argB) {
+  const data = typeof argA === "string" ? { content: argA, thumbnail: argB } : argA;
+  return data.thumbnail ? createSection(data.content, data.thumbnail) : createTextDisplay(data.content);
+}
+
+export { createThumbArea };

package/dist/index.cjs

@@ -17,6 +17,7 @@ const gallery = require('./functions/components/gallery.cjs');
 const separator$1 = require('./functions/components/separator.cjs');
 const section = require('./functions/components/section.cjs');
 const text = require('./functions/components/text.cjs');
+const thumbarea = require('./functions/components/thumbarea.cjs');
 const thumbnail = require('./functions/components/thumbnail.cjs');
 const components = require('./functions/components/components.cjs');
 const container = require('./functions/components/container.cjs');
@@ -56,6 +57,7 @@ exports.createMediaGallery = gallery.createMediaGallery;
 exports.createSeparator = separator$1.createSeparator;
 exports.createSection = section.createSection;
 exports.createTextDisplay = text.createTextDisplay;
+exports.createThumbArea = thumbarea.createThumbArea;
 exports.createThumbnail = thumbnail.createThumbnail;
 exports.createComponents = components.createComponents;
 exports.createContainer = container.createContainer;

package/dist/index.d.cts

@@ -505,7 +505,48 @@ declare function createSection(data: SectionData): SectionBuilder;
  */
 declare function createTextDisplay(content: string, id?: number): TextDisplayBuilder;
 
-type ComponentData = TextDisplayBuilder | SeparatorBuilder | FileBuilder | SectionBuilder | MediaGalleryBuilder | ActionRowBuilder<MessageActionRowComponentBuilder> | MessageActionRowComponentBuilder[] | MessageActionRowComponentBuilder | Attachment | AttachmentBuilder | string | null | undefined;
+type ThumbAreaThumbnail = SectionThumbnailAccessory | null | undefined;
+type ThumbAreaData = {
+    content: string;
+    thumbnail?: ThumbAreaThumbnail;
+};
+/**
+ * Creates either a {@link SectionBuilder} or a {@link TextDisplayBuilder} based on the presence of a thumbnail.
+ *
+ * If a thumbnail is provided, this function will return a {@link SectionBuilder} with the content and thumbnail.
+ * Otherwise, it will return a {@link TextDisplayBuilder} with only the provided content.
+ *
+ * ---
+ * **Overloads:**
+ * - Provide `content` and optional `thumbnail` as separate parameters.
+ * - Provide a single object with `content` and optional `thumbnail` properties.
+ *
+ * @param content - The text content to be displayed.
+ * @param thumbnail - (Optional) A thumbnail to include. If provided, a section will be created; otherwise, a simple text display.
+ *
+ * @param data - An object containing `content` and optional `thumbnail` properties.
+ *
+ * @returns A {@link SectionBuilder} if a thumbnail is provided, otherwise a {@link TextDisplayBuilder}.
+ *
+ * @example
+ * // Using positional parameters with a thumbnail
+ * const thumbSection = createThumbArea("Welcome!", "https://example.com/image.png");
+ *
+ * @example
+ * // Using an object without a thumbnail
+ * const textOnly = createThumbArea({ content: "Just text here" });
+ *
+ * @example
+ * // Using an object with a thumbnail
+ * const thumbSection = createThumbArea({
+ *   content: "Check this out!",
+ *   thumbnail: "https://example.com/image.png"
+ * });
+ */
+declare function createThumbArea(content: string, thumbnail?: ThumbAreaThumbnail): SectionBuilder | TextDisplayBuilder;
+declare function createThumbArea(data: ThumbAreaData): SectionBuilder | TextDisplayBuilder;
+
+type ComponentData = TextDisplayBuilder | SeparatorBuilder | FileBuilder | SectionBuilder | MediaGalleryBuilder | ActionRowBuilder<MessageActionRowComponentBuilder> | MessageActionRowComponentBuilder[] | MessageActionRowComponentBuilder | Attachment | AttachmentBuilder | string | null | undefined | boolean;
 type CreateComponentData = ComponentData | ContainerBuilder;
 declare function createComponents(...data: (CreateComponentData | CreateComponentData[])[]): (SeparatorBuilder | TextDisplayBuilder | FileBuilder | SectionBuilder | MediaGalleryBuilder | ActionRowBuilder<MessageActionRowComponentBuilder> | ContainerBuilder)[];
 
@@ -694,5 +735,5 @@ declare function isAnySelectMenuBuilder(value: unknown): value is AnySelectMenuB
 
 declare function isButtonBuilder(value: unknown): value is ButtonBuilder;
 
-export { CustomItents, CustomPartials, EmbedLimit, EmbedPlusBuilder, Separator, chars, commandMention, createComponents, createContainer, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createFile, createLinkButton, createMediaGallery, createModalFields, createModalInput, createRow, createSection, createSeparator, createTextDisplay, createThumbnail, createWebhookClient, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, isAnySelectMenuBuilder, isAttachment, isButtonBuilder, modalFieldsToRecord, setMobileStatus, wrapButtons };
-export type { AnyEmbedData, AnySelectMenuBuilder, ComponentData, ContainerColor, ContainerData, EmbedPlusAssetData, EmbedPlusAuthorData, EmbedPlusColorData, EmbedPlusData, EmbedPlusFooterData, EmbedPlusProperty, SectionAccessory, SectionAccessoryData, SectionButtonAccessory, SectionData, SectionThumbnailAccessory, SeparatorData, ThumbnailData };
+export { CustomItents, CustomPartials, EmbedLimit, EmbedPlusBuilder, Separator, chars, commandMention, createComponents, createContainer, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createFile, createLinkButton, createMediaGallery, createModalFields, createModalInput, createRow, createSection, createSeparator, createTextDisplay, createThumbArea, createThumbnail, createWebhookClient, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, isAnySelectMenuBuilder, isAttachment, isButtonBuilder, modalFieldsToRecord, setMobileStatus, wrapButtons };
+export type { AnyEmbedData, AnySelectMenuBuilder, ComponentData, ContainerColor, ContainerData, EmbedPlusAssetData, EmbedPlusAuthorData, EmbedPlusColorData, EmbedPlusData, EmbedPlusFooterData, EmbedPlusProperty, SectionAccessory, SectionAccessoryData, SectionButtonAccessory, SectionData, SectionThumbnailAccessory, SeparatorData, ThumbAreaData, ThumbAreaThumbnail, ThumbnailData };

package/dist/index.d.mts

@@ -505,7 +505,48 @@ declare function createSection(data: SectionData): SectionBuilder;
  */
 declare function createTextDisplay(content: string, id?: number): TextDisplayBuilder;
 
-type ComponentData = TextDisplayBuilder | SeparatorBuilder | FileBuilder | SectionBuilder | MediaGalleryBuilder | ActionRowBuilder<MessageActionRowComponentBuilder> | MessageActionRowComponentBuilder[] | MessageActionRowComponentBuilder | Attachment | AttachmentBuilder | string | null | undefined;
+type ThumbAreaThumbnail = SectionThumbnailAccessory | null | undefined;
+type ThumbAreaData = {
+    content: string;
+    thumbnail?: ThumbAreaThumbnail;
+};
+/**
+ * Creates either a {@link SectionBuilder} or a {@link TextDisplayBuilder} based on the presence of a thumbnail.
+ *
+ * If a thumbnail is provided, this function will return a {@link SectionBuilder} with the content and thumbnail.
+ * Otherwise, it will return a {@link TextDisplayBuilder} with only the provided content.
+ *
+ * ---
+ * **Overloads:**
+ * - Provide `content` and optional `thumbnail` as separate parameters.
+ * - Provide a single object with `content` and optional `thumbnail` properties.
+ *
+ * @param content - The text content to be displayed.
+ * @param thumbnail - (Optional) A thumbnail to include. If provided, a section will be created; otherwise, a simple text display.
+ *
+ * @param data - An object containing `content` and optional `thumbnail` properties.
+ *
+ * @returns A {@link SectionBuilder} if a thumbnail is provided, otherwise a {@link TextDisplayBuilder}.
+ *
+ * @example
+ * // Using positional parameters with a thumbnail
+ * const thumbSection = createThumbArea("Welcome!", "https://example.com/image.png");
+ *
+ * @example
+ * // Using an object without a thumbnail
+ * const textOnly = createThumbArea({ content: "Just text here" });
+ *
+ * @example
+ * // Using an object with a thumbnail
+ * const thumbSection = createThumbArea({
+ *   content: "Check this out!",
+ *   thumbnail: "https://example.com/image.png"
+ * });
+ */
+declare function createThumbArea(content: string, thumbnail?: ThumbAreaThumbnail): SectionBuilder | TextDisplayBuilder;
+declare function createThumbArea(data: ThumbAreaData): SectionBuilder | TextDisplayBuilder;
+
+type ComponentData = TextDisplayBuilder | SeparatorBuilder | FileBuilder | SectionBuilder | MediaGalleryBuilder | ActionRowBuilder<MessageActionRowComponentBuilder> | MessageActionRowComponentBuilder[] | MessageActionRowComponentBuilder | Attachment | AttachmentBuilder | string | null | undefined | boolean;
 type CreateComponentData = ComponentData | ContainerBuilder;
 declare function createComponents(...data: (CreateComponentData | CreateComponentData[])[]): (SeparatorBuilder | TextDisplayBuilder | FileBuilder | SectionBuilder | MediaGalleryBuilder | ActionRowBuilder<MessageActionRowComponentBuilder> | ContainerBuilder)[];
 
@@ -694,5 +735,5 @@ declare function isAnySelectMenuBuilder(value: unknown): value is AnySelectMenuB
 
 declare function isButtonBuilder(value: unknown): value is ButtonBuilder;
 
-export { CustomItents, CustomPartials, EmbedLimit, EmbedPlusBuilder, Separator, chars, commandMention, createComponents, createContainer, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createFile, createLinkButton, createMediaGallery, createModalFields, createModalInput, createRow, createSection, createSeparator, createTextDisplay, createThumbnail, createWebhookClient, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, isAnySelectMenuBuilder, isAttachment, isButtonBuilder, modalFieldsToRecord, setMobileStatus, wrapButtons };
-export type { AnyEmbedData, AnySelectMenuBuilder, ComponentData, ContainerColor, ContainerData, EmbedPlusAssetData, EmbedPlusAuthorData, EmbedPlusColorData, EmbedPlusData, EmbedPlusFooterData, EmbedPlusProperty, SectionAccessory, SectionAccessoryData, SectionButtonAccessory, SectionData, SectionThumbnailAccessory, SeparatorData, ThumbnailData };
+export { CustomItents, CustomPartials, EmbedLimit, EmbedPlusBuilder, Separator, chars, commandMention, createComponents, createContainer, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createFile, createLinkButton, createMediaGallery, createModalFields, createModalInput, createRow, createSection, createSeparator, createTextDisplay, createThumbArea, createThumbnail, createWebhookClient, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, isAnySelectMenuBuilder, isAttachment, isButtonBuilder, modalFieldsToRecord, setMobileStatus, wrapButtons };
+export type { AnyEmbedData, AnySelectMenuBuilder, ComponentData, ContainerColor, ContainerData, EmbedPlusAssetData, EmbedPlusAuthorData, EmbedPlusColorData, EmbedPlusData, EmbedPlusFooterData, EmbedPlusProperty, SectionAccessory, SectionAccessoryData, SectionButtonAccessory, SectionData, SectionThumbnailAccessory, SeparatorData, ThumbAreaData, ThumbAreaThumbnail, ThumbnailData };

package/dist/index.d.ts

@@ -505,7 +505,48 @@ declare function createSection(data: SectionData): SectionBuilder;
  */
 declare function createTextDisplay(content: string, id?: number): TextDisplayBuilder;
 
-type ComponentData = TextDisplayBuilder | SeparatorBuilder | FileBuilder | SectionBuilder | MediaGalleryBuilder | ActionRowBuilder<MessageActionRowComponentBuilder> | MessageActionRowComponentBuilder[] | MessageActionRowComponentBuilder | Attachment | AttachmentBuilder | string | null | undefined;
+type ThumbAreaThumbnail = SectionThumbnailAccessory | null | undefined;
+type ThumbAreaData = {
+    content: string;
+    thumbnail?: ThumbAreaThumbnail;
+};
+/**
+ * Creates either a {@link SectionBuilder} or a {@link TextDisplayBuilder} based on the presence of a thumbnail.
+ *
+ * If a thumbnail is provided, this function will return a {@link SectionBuilder} with the content and thumbnail.
+ * Otherwise, it will return a {@link TextDisplayBuilder} with only the provided content.
+ *
+ * ---
+ * **Overloads:**
+ * - Provide `content` and optional `thumbnail` as separate parameters.
+ * - Provide a single object with `content` and optional `thumbnail` properties.
+ *
+ * @param content - The text content to be displayed.
+ * @param thumbnail - (Optional) A thumbnail to include. If provided, a section will be created; otherwise, a simple text display.
+ *
+ * @param data - An object containing `content` and optional `thumbnail` properties.
+ *
+ * @returns A {@link SectionBuilder} if a thumbnail is provided, otherwise a {@link TextDisplayBuilder}.
+ *
+ * @example
+ * // Using positional parameters with a thumbnail
+ * const thumbSection = createThumbArea("Welcome!", "https://example.com/image.png");
+ *
+ * @example
+ * // Using an object without a thumbnail
+ * const textOnly = createThumbArea({ content: "Just text here" });
+ *
+ * @example
+ * // Using an object with a thumbnail
+ * const thumbSection = createThumbArea({
+ *   content: "Check this out!",
+ *   thumbnail: "https://example.com/image.png"
+ * });
+ */
+declare function createThumbArea(content: string, thumbnail?: ThumbAreaThumbnail): SectionBuilder | TextDisplayBuilder;
+declare function createThumbArea(data: ThumbAreaData): SectionBuilder | TextDisplayBuilder;
+
+type ComponentData = TextDisplayBuilder | SeparatorBuilder | FileBuilder | SectionBuilder | MediaGalleryBuilder | ActionRowBuilder<MessageActionRowComponentBuilder> | MessageActionRowComponentBuilder[] | MessageActionRowComponentBuilder | Attachment | AttachmentBuilder | string | null | undefined | boolean;
 type CreateComponentData = ComponentData | ContainerBuilder;
 declare function createComponents(...data: (CreateComponentData | CreateComponentData[])[]): (SeparatorBuilder | TextDisplayBuilder | FileBuilder | SectionBuilder | MediaGalleryBuilder | ActionRowBuilder<MessageActionRowComponentBuilder> | ContainerBuilder)[];
 
@@ -694,5 +735,5 @@ declare function isAnySelectMenuBuilder(value: unknown): value is AnySelectMenuB
 
 declare function isButtonBuilder(value: unknown): value is ButtonBuilder;
 
-export { CustomItents, CustomPartials, EmbedLimit, EmbedPlusBuilder, Separator, chars, commandMention, createComponents, createContainer, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createFile, createLinkButton, createMediaGallery, createModalFields, createModalInput, createRow, createSection, createSeparator, createTextDisplay, createThumbnail, createWebhookClient, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, isAnySelectMenuBuilder, isAttachment, isButtonBuilder, modalFieldsToRecord, setMobileStatus, wrapButtons };
-export type { AnyEmbedData, AnySelectMenuBuilder, ComponentData, ContainerColor, ContainerData, EmbedPlusAssetData, EmbedPlusAuthorData, EmbedPlusColorData, EmbedPlusData, EmbedPlusFooterData, EmbedPlusProperty, SectionAccessory, SectionAccessoryData, SectionButtonAccessory, SectionData, SectionThumbnailAccessory, SeparatorData, ThumbnailData };
+export { CustomItents, CustomPartials, EmbedLimit, EmbedPlusBuilder, Separator, chars, commandMention, createComponents, createContainer, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createFile, createLinkButton, createMediaGallery, createModalFields, createModalInput, createRow, createSection, createSeparator, createTextDisplay, createThumbArea, createThumbnail, createWebhookClient, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, isAnySelectMenuBuilder, isAttachment, isButtonBuilder, modalFieldsToRecord, setMobileStatus, wrapButtons };
+export type { AnyEmbedData, AnySelectMenuBuilder, ComponentData, ContainerColor, ContainerData, EmbedPlusAssetData, EmbedPlusAuthorData, EmbedPlusColorData, EmbedPlusData, EmbedPlusFooterData, EmbedPlusProperty, SectionAccessory, SectionAccessoryData, SectionButtonAccessory, SectionData, SectionThumbnailAccessory, SeparatorData, ThumbAreaData, ThumbAreaThumbnail, ThumbnailData };

package/dist/index.mjs

@@ -15,6 +15,7 @@ export { createMediaGallery } from './functions/components/gallery.mjs';
 export { createSeparator } from './functions/components/separator.mjs';
 export { createSection } from './functions/components/section.mjs';
 export { createTextDisplay } from './functions/components/text.mjs';
+export { createThumbArea } from './functions/components/thumbarea.mjs';
 export { createThumbnail } from './functions/components/thumbnail.mjs';
 export { createComponents } from './functions/components/components.mjs';
 export { createContainer } from './functions/components/container.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magicyan/discord",
-  "version": "1.4.8",
+  "version": "1.4.10",
   "description": "Simple functions to facilitate discord bot development",
   "license": "MIT",
   "type": "module",
@@ -39,7 +39,7 @@
     "test": "vitest"
   },
   "peerDependencies": {
-    "discord.js": "^14.19.1"
+    "discord.js": "^14.19.3"
   },
   "devDependencies": {
     "@magicyan/config": "*",
@@ -49,6 +49,6 @@
     "vitest": "^2.1.9"
   },
   "dependencies": {
-    "@magicyan/core": "^1.1.0"
+    "@magicyan/core": "^1.1.1"
   }
 }