@zoodogood/utils 1.0.4-change.334 → 1.0.5-change.421

package/lib/discordjs/mod.d.ts

@@ -1,37 +1,54 @@
-export function CreateMessage({ content, title, url, author, thumbnail, description, color, fields, image, video, footer, timestamp, ephemeral, fetchReply, components, files, reference }: {
-    content: any;
-    title: any;
-    url: any;
-    author: any;
-    thumbnail: any;
-    description: any;
-    color: any;
-    fields: any;
-    image: any;
-    video: any;
-    footer: any;
-    timestamp: any;
-    ephemeral: any;
-    fetchReply: any;
-    components: any;
-    files: any;
-    reference: any;
-}): {
-    embeds: EmbedBuilder[];
-    files: any;
-    reply: {
-        messageReference: any;
-    };
-    components: any;
-    content: any;
-    ephemeral: any;
-    fetchReply: any;
-};
+/**
+ * Create a message object for Discord.
+ *
+ * @param {Object} params = Parameters for creating the message.
+ * @param {string} [params.content] - The message content.
+ * @param {string} [params.title] - The title of the embed.
+ * @param {string} [params.url] - The URL of the embed.
+ * @param {Object} [params.author] - The author of the embed.
+ * @param {string} [params.thumbnail] - The thumbnail URL of the embed.
+ * @param {string} [params.description] - The description of the embed.
+ * @param {string} [params.color] - The color of the embed.
+ * @param {Object[]} [params.fields] - The fields of the embed.
+ * @param {string} [params.image] - The image URL of the embed.
+ * @param {string} [params.video] - The video URL of the embed.
+ * @param {Object} [params.footer] - The footer of the embed.
+ * @param {string} [params.timestamp] - The timestamp of the embed.
+ * @param {boolean} [params.ephemeral] - Whether the message should be ephemeral.
+ * @param {boolean} [params.fetchReply] - Whether to fetch the message reply.
+ * @param {Object[] | Object} [params.components] - The message components.
+ * @param {Object[] | Object[]} [params.files] - The message files.
+ * @param {string} [params.reference] - The message reference.
+ * @returns {Object} - The message object.
+ */
+export function CreateMessage({ content, title, url, author, thumbnail, description, color, fields, image, video, footer, timestamp, ephemeral, fetchReply, components, files, reference, }: {
+    content?: string | undefined;
+    title?: string | undefined;
+    url?: string | undefined;
+    author?: Object | undefined;
+    thumbnail?: string | undefined;
+    description?: string | undefined;
+    color?: string | undefined;
+    fields?: Object[] | undefined;
+    image?: string | undefined;
+    video?: string | undefined;
+    footer?: Object | undefined;
+    timestamp?: string | undefined;
+    ephemeral?: boolean | undefined;
+    fetchReply?: boolean | undefined;
+    components?: Object | Object[] | undefined;
+    files?: Object[] | undefined;
+    reference?: string | undefined;
+}): Object;
 export function CreateModal({ title, customId, components }: {
     title: any;
     customId: any;
     components: any;
 }): import("discord.js").APIModalInteractionResponseCallbackData;
 export function SimplifyComponents(data: any): any;
+/**
+ *
+ * @param {*} embed
+ * @returns {boolean}
+ */
 export function isEmptyEmbed(embed: any): boolean;
-import { EmbedBuilder } from 'discord.js';

package/lib/discordjs/mod.js

@@ -1,5 +1,10 @@
-import { EmbedBuilder, ModalBuilder, resolveColor, ActionRow } from 'discord.js';
-import { ComponentType } from 'discord-api-types/v10';
+import { EmbedBuilder, ModalBuilder, resolveColor, ActionRow, } from "discord.js";
+import { ComponentType } from "discord-api-types/v10";
+/**
+ *
+ * @param {*} embed
+ * @returns {boolean}
+ */
 function isEmptyEmbed(embed) {
     const DEFAULT_PROPERTIES = {
         title: undefined,
@@ -10,24 +15,54 @@ function isEmptyEmbed(embed) {
         image: undefined,
         footer: undefined,
         timestamp: undefined,
-        video: undefined
+        video: undefined,
     };
     // in isEmptyEmbed context is a good compare
     const isEqualDefault = (key) => String(embed[key]) === String(DEFAULT_PROPERTIES[key]);
-    const isEveryPropertyDefault = Object.keys(DEFAULT_PROPERTIES)
-        .every(isEqualDefault);
+    const isEveryPropertyDefault = Object.keys(DEFAULT_PROPERTIES).every(isEqualDefault);
     return isEveryPropertyDefault;
 }
-function CreateMessage({ content, title, url, author, thumbnail, description, color, fields, image, video, footer, timestamp, ephemeral, fetchReply, components, files, reference }) {
+/**
+ * Create a message object for Discord.
+ *
+ * @param {Object} params = Parameters for creating the message.
+ * @param {string} [params.content] - The message content.
+ * @param {string} [params.title] - The title of the embed.
+ * @param {string} [params.url] - The URL of the embed.
+ * @param {Object} [params.author] - The author of the embed.
+ * @param {string} [params.thumbnail] - The thumbnail URL of the embed.
+ * @param {string} [params.description] - The description of the embed.
+ * @param {string} [params.color] - The color of the embed.
+ * @param {Object[]} [params.fields] - The fields of the embed.
+ * @param {string} [params.image] - The image URL of the embed.
+ * @param {string} [params.video] - The video URL of the embed.
+ * @param {Object} [params.footer] - The footer of the embed.
+ * @param {string} [params.timestamp] - The timestamp of the embed.
+ * @param {boolean} [params.ephemeral] - Whether the message should be ephemeral.
+ * @param {boolean} [params.fetchReply] - Whether to fetch the message reply.
+ * @param {Object[] | Object} [params.components] - The message components.
+ * @param {Object[] | Object[]} [params.files] - The message files.
+ * @param {string} [params.reference] - The message reference.
+ * @returns {Object} - The message object.
+ */
+function CreateMessage({ content, title, url, author, thumbnail, description, color, fields, image, video, footer, timestamp, ephemeral, fetchReply, components, files, reference, }) {
     const message = {};
     thumbnail && (thumbnail = { url: thumbnail });
     image && (image = { url: image });
     video && (video = { url: video });
     color = resolveColor(color !== null && color !== void 0 ? color : "Random");
     const embed = new EmbedBuilder({
-        title, url, author, thumbnail,
-        description, color, fields,
-        image, video, footer, timestamp
+        title,
+        url,
+        author,
+        thumbnail,
+        description,
+        color,
+        fields,
+        image,
+        video,
+        footer,
+        timestamp,
     });
     if (!isEmptyEmbed(embed.data)) {
         message.embeds = [embed];
@@ -37,7 +72,7 @@ function CreateMessage({ content, title, url, author, thumbnail, description, co
     }
     if (reference)
         message.reply = {
-            messageReference: reference
+            messageReference: reference,
         };
     message.components = components ? SimplifyComponents(components) : null;
     message.content = content;
@@ -52,27 +87,29 @@ function CreateModal({ title, customId, components }) {
 function SimplifyComponents(data) {
     if (data instanceof Array && data.length === 0)
         return [];
-    const isComponent = (component) => "type" in component;
-    const isActionRow = (component) => component instanceof Array && isComponent(component.at(0)) || component instanceof ActionRow;
-    const isComponents = (component) => component.length && isActionRow(component.at(0));
+    const isComponent = (component) => "type" in component && component.type !== ComponentType.ActionRow;
+    const isActionRow = (component) => (component instanceof Array && isComponent(component.at(0))) ||
+        component instanceof ActionRow;
+    const isComponents = (component) => component instanceof Array && isActionRow(component.at(0));
     const argumentType = [
         isComponent(data),
         isActionRow(data),
-        isComponents(data)
+        isComponents(data),
     ].findIndex(Boolean);
     if (argumentType === -1)
         throw new TypeError("expected component");
-    const inArray = (component) => [component];
+    const wrapToArray = (component) => [component];
     const arrayToActionRow = (componentsArray) => {
-        if (componentsArray.type === ComponentType.ActionRow)
+        const isActionRow = "type" in componentsArray &&
+            componentsArray.type === ComponentType.ActionRow;
+        if (isActionRow)
             return componentsArray;
         return { type: ComponentType.ActionRow, components: componentsArray };
     };
-    const actionRowInArray = (actionRow) => [actionRow];
     if (argumentType <= 0)
-        data = inArray(data);
+        data = wrapToArray(data);
     if (argumentType <= 1)
-        data = actionRowInArray(data);
+        data = wrapToArray(data);
     data = data.map(arrayToActionRow);
     return data;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zoodogood/utils",
   "type": "module",
-  "version": "1.0.4-change.334",
+  "version": "1.0.5-change.421",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",