@magicyan/discord 1.2.0 → 1.2.2

package/dist/constants/embed.cjs

@@ -0,0 +1,15 @@
+'use strict';
+
+var EmbedLimit = /* @__PURE__ */ ((EmbedLimit2) => {
+  EmbedLimit2[EmbedLimit2["AuthorName"] = 256] = "AuthorName";
+  EmbedLimit2[EmbedLimit2["Title"] = 256] = "Title";
+  EmbedLimit2[EmbedLimit2["Description"] = 4096] = "Description";
+  EmbedLimit2[EmbedLimit2["Fields"] = 25] = "Fields";
+  EmbedLimit2[EmbedLimit2["FieldName"] = 256] = "FieldName";
+  EmbedLimit2[EmbedLimit2["FieldValue"] = 1024] = "FieldValue";
+  EmbedLimit2[EmbedLimit2["FooterText"] = 2048] = "FooterText";
+  EmbedLimit2[EmbedLimit2["URL"] = 2048] = "URL";
+  return EmbedLimit2;
+})(EmbedLimit || {});
+
+exports.EmbedLimit = EmbedLimit;

package/dist/constants/embed.mjs

@@ -0,0 +1,13 @@
+var EmbedLimit = /* @__PURE__ */ ((EmbedLimit2) => {
+  EmbedLimit2[EmbedLimit2["AuthorName"] = 256] = "AuthorName";
+  EmbedLimit2[EmbedLimit2["Title"] = 256] = "Title";
+  EmbedLimit2[EmbedLimit2["Description"] = 4096] = "Description";
+  EmbedLimit2[EmbedLimit2["Fields"] = 25] = "Fields";
+  EmbedLimit2[EmbedLimit2["FieldName"] = 256] = "FieldName";
+  EmbedLimit2[EmbedLimit2["FieldValue"] = 1024] = "FieldValue";
+  EmbedLimit2[EmbedLimit2["FooterText"] = 2048] = "FooterText";
+  EmbedLimit2[EmbedLimit2["URL"] = 2048] = "URL";
+  return EmbedLimit2;
+})(EmbedLimit || {});
+
+export { EmbedLimit };

package/dist/functions/embeds/assets.cjs

@@ -2,12 +2,12 @@
 
 const discord_js = require('discord.js');
 
-function createEmbedAsset(source, options) {
+function createEmbedAsset(source, options = {}) {
   if (source instanceof discord_js.Attachment || source instanceof discord_js.AttachmentBuilder) {
     return { url: `attachment://${source.name}`, ...options };
   }
   if (source && typeof source === "object" && "url" in source) {
-    return Object.assign(source, options ?? (options = {}));
+    return Object.assign(source, options);
   }
   return source ? Object.assign({ url: source }, options) : void 0;
 }

package/dist/functions/embeds/assets.mjs

@@ -1,11 +1,11 @@
 import { Attachment, AttachmentBuilder } from 'discord.js';
 
-function createEmbedAsset(source, options) {
+function createEmbedAsset(source, options = {}) {
   if (source instanceof Attachment || source instanceof AttachmentBuilder) {
     return { url: `attachment://${source.name}`, ...options };
   }
   if (source && typeof source === "object" && "url" in source) {
-    return Object.assign(source, options ?? (options = {}));
+    return Object.assign(source, options);
   }
   return source ? Object.assign({ url: source }, options) : void 0;
 }

package/dist/functions/embeds/author.cjs

@@ -27,7 +27,7 @@ function createEmbedAuthor(type, options) {
       break;
     }
   }
-  return { name: `${prefix}${name}${suffix}`, url: url ?? void 0, iconURL };
+  return { name: `${prefix}${name}${suffix}`, url: url?.toString(), iconURL };
 }
 
 exports.createEmbedAuthor = createEmbedAuthor;

package/dist/functions/embeds/author.mjs

@@ -25,7 +25,7 @@ function createEmbedAuthor(type, options) {
       break;
     }
   }
-  return { name: `${prefix}${name}${suffix}`, url: url ?? void 0, iconURL };
+  return { name: `${prefix}${name}${suffix}`, url: url?.toString(), iconURL };
 }
 
 export { createEmbedAuthor };

package/dist/index.cjs

@@ -2,6 +2,7 @@
 
 const chars = require('./constants/chars.cjs');
 const client = require('./constants/client.cjs');
+const embed = require('./constants/embed.cjs');
 const misc = require('./functions/misc.cjs');
 const assets = require('./functions/embeds/assets.cjs');
 const author = require('./functions/embeds/author.cjs');
@@ -24,6 +25,7 @@ const core = require('@magicyan/core');
 exports.chars = chars.chars;
 exports.CustomItents = client.CustomItents;
 exports.CustomPartials = client.CustomPartials;
+exports.EmbedLimit = embed.EmbedLimit;
 exports.setMobileStatus = misc.setMobileStatus;
 exports.createEmbedAsset = assets.createEmbedAsset;
 exports.createEmbedAuthor = author.createEmbedAuthor;

package/dist/index.d.cts

@@ -16,19 +16,35 @@ declare const CustomPartials: {
     All: Partials[];
 };
 
+/**
+ * Embed limits
+ * @see https://discordjs.guide/popular-topics/embeds.html#embed-limits
+ */
+declare enum EmbedLimit {
+    AuthorName = 256,
+    Title = 256,
+    Description = 4096,
+    Fields = 25,
+    FieldName = 256,
+    FieldValue = 1024,
+    FooterText = 2048,
+    URL = 2048
+}
+
 declare function setMobileStatus(): void;
 
 type EmbedPlusAssetData = string | Attachment | AttachmentBuilder | EmbedAssetData | undefined | null;
 type EmbedAssetOptions = Omit<EmbedAssetData, "url">;
 declare function createEmbedAsset(source: EmbedPlusAssetData, options?: EmbedAssetOptions): EmbedAssetData | undefined;
 
+type IdentityProperty = "username" | "displayName" | "id" | "globalName" | "nickname";
 interface MemberAuthor {
     type: GuildMember;
-    property?: "username" | "displayName" | "id" | "globalName" | "nickname";
+    property?: IdentityProperty;
 }
 interface UserAuthor {
     type: User | ClientUser;
-    property?: "username" | "displayName" | "id" | "globalName";
+    property?: Exclude<IdentityProperty, "nickname">;
 }
 interface GuildAuthor {
     type: Guild;
@@ -292,4 +308,4 @@ declare function findRole(guild: Guild): {
  */
 declare function extractMentionId(mention: string): string | null;
 
-export { type AnyEmbedData, CustomItents, CustomPartials, type EmbedPlusAssetData, type EmbedPlusAuthorData, EmbedPlusBuilder, type EmbedPlusColorData, type EmbedPlusData, type EmbedPlusFooterData, type EmbedPlusProperty, chars, commandMention, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createLinkButton, createModalFields, createModalInput, createRow, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, modalFieldsToRecord, setMobileStatus };
+export { type AnyEmbedData, CustomItents, CustomPartials, EmbedLimit, type EmbedPlusAssetData, type EmbedPlusAuthorData, EmbedPlusBuilder, type EmbedPlusColorData, type EmbedPlusData, type EmbedPlusFooterData, type EmbedPlusProperty, chars, commandMention, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createLinkButton, createModalFields, createModalInput, createRow, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, modalFieldsToRecord, setMobileStatus };

package/dist/index.d.mts

@@ -16,19 +16,35 @@ declare const CustomPartials: {
     All: Partials[];
 };
 
+/**
+ * Embed limits
+ * @see https://discordjs.guide/popular-topics/embeds.html#embed-limits
+ */
+declare enum EmbedLimit {
+    AuthorName = 256,
+    Title = 256,
+    Description = 4096,
+    Fields = 25,
+    FieldName = 256,
+    FieldValue = 1024,
+    FooterText = 2048,
+    URL = 2048
+}
+
 declare function setMobileStatus(): void;
 
 type EmbedPlusAssetData = string | Attachment | AttachmentBuilder | EmbedAssetData | undefined | null;
 type EmbedAssetOptions = Omit<EmbedAssetData, "url">;
 declare function createEmbedAsset(source: EmbedPlusAssetData, options?: EmbedAssetOptions): EmbedAssetData | undefined;
 
+type IdentityProperty = "username" | "displayName" | "id" | "globalName" | "nickname";
 interface MemberAuthor {
     type: GuildMember;
-    property?: "username" | "displayName" | "id" | "globalName" | "nickname";
+    property?: IdentityProperty;
 }
 interface UserAuthor {
     type: User | ClientUser;
-    property?: "username" | "displayName" | "id" | "globalName";
+    property?: Exclude<IdentityProperty, "nickname">;
 }
 interface GuildAuthor {
     type: Guild;
@@ -292,4 +308,4 @@ declare function findRole(guild: Guild): {
  */
 declare function extractMentionId(mention: string): string | null;
 
-export { type AnyEmbedData, CustomItents, CustomPartials, type EmbedPlusAssetData, type EmbedPlusAuthorData, EmbedPlusBuilder, type EmbedPlusColorData, type EmbedPlusData, type EmbedPlusFooterData, type EmbedPlusProperty, chars, commandMention, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createLinkButton, createModalFields, createModalInput, createRow, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, modalFieldsToRecord, setMobileStatus };
+export { type AnyEmbedData, CustomItents, CustomPartials, EmbedLimit, type EmbedPlusAssetData, type EmbedPlusAuthorData, EmbedPlusBuilder, type EmbedPlusColorData, type EmbedPlusData, type EmbedPlusFooterData, type EmbedPlusProperty, chars, commandMention, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createLinkButton, createModalFields, createModalInput, createRow, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, modalFieldsToRecord, setMobileStatus };

package/dist/index.d.ts

@@ -16,19 +16,35 @@ declare const CustomPartials: {
     All: Partials[];
 };
 
+/**
+ * Embed limits
+ * @see https://discordjs.guide/popular-topics/embeds.html#embed-limits
+ */
+declare enum EmbedLimit {
+    AuthorName = 256,
+    Title = 256,
+    Description = 4096,
+    Fields = 25,
+    FieldName = 256,
+    FieldValue = 1024,
+    FooterText = 2048,
+    URL = 2048
+}
+
 declare function setMobileStatus(): void;
 
 type EmbedPlusAssetData = string | Attachment | AttachmentBuilder | EmbedAssetData | undefined | null;
 type EmbedAssetOptions = Omit<EmbedAssetData, "url">;
 declare function createEmbedAsset(source: EmbedPlusAssetData, options?: EmbedAssetOptions): EmbedAssetData | undefined;
 
+type IdentityProperty = "username" | "displayName" | "id" | "globalName" | "nickname";
 interface MemberAuthor {
     type: GuildMember;
-    property?: "username" | "displayName" | "id" | "globalName" | "nickname";
+    property?: IdentityProperty;
 }
 interface UserAuthor {
     type: User | ClientUser;
-    property?: "username" | "displayName" | "id" | "globalName";
+    property?: Exclude<IdentityProperty, "nickname">;
 }
 interface GuildAuthor {
     type: Guild;
@@ -292,4 +308,4 @@ declare function findRole(guild: Guild): {
  */
 declare function extractMentionId(mention: string): string | null;
 
-export { type AnyEmbedData, CustomItents, CustomPartials, type EmbedPlusAssetData, type EmbedPlusAuthorData, EmbedPlusBuilder, type EmbedPlusColorData, type EmbedPlusData, type EmbedPlusFooterData, type EmbedPlusProperty, chars, commandMention, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createLinkButton, createModalFields, createModalInput, createRow, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, modalFieldsToRecord, setMobileStatus };
+export { type AnyEmbedData, CustomItents, CustomPartials, EmbedLimit, type EmbedPlusAssetData, type EmbedPlusAuthorData, EmbedPlusBuilder, type EmbedPlusColorData, type EmbedPlusData, type EmbedPlusFooterData, type EmbedPlusProperty, chars, commandMention, createEmbed, createEmbedAsset, createEmbedAuthor, createEmbedFiles, createEmbedFooter, createLinkButton, createModalFields, createModalInput, createRow, extractMentionId, findChannel, findCommand, findEmoji, findMember, findMessage, findRole, getChannelUrlInfo, getMessageUrlInfo, modalFieldsToRecord, setMobileStatus };

package/dist/index.mjs

@@ -1,5 +1,6 @@
 export { chars } from './constants/chars.mjs';
 export { CustomItents, CustomPartials } from './constants/client.mjs';
+export { EmbedLimit } from './constants/embed.mjs';
 export { setMobileStatus } from './functions/misc.mjs';
 export { createEmbedAsset } from './functions/embeds/assets.mjs';
 export { createEmbedAuthor } from './functions/embeds/author.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magicyan/discord",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Simple functions to facilitate discord bot development",
   "license": "MIT",
   "type": "module",
@@ -39,7 +39,7 @@
     "unbuild": "^2.0.0"
   },
   "dependencies": {
-    "@magicyan/core": "^1.0.19"
+    "@magicyan/core": "^1.0.20"
   },
   "peerDependencies": {
     "discord.js": "^14.16.3"