@sapphire/discord.js-utilities 7.3.3-next.ff2c792d → 7.3.3

package/dist/cjs/index.d.cts

@@ -1,5 +1,5 @@
 export * from '@sapphire/discord-utilities';
-import { MessageCreateOptions, CategoryChannel, DMChannel, DirectoryChannel, PartialDMChannel, NewsChannel, StageChannel, TextChannel, ThreadChannel, VoiceChannel, GuildChannel, Channel, Message, ChatInputCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, AutocompleteInteraction, StringSelectMenuInteraction, ButtonInteraction, Interaction, PartialTextBasedChannelFields, EmojiIdentifierResolvable, User, CollectorFilter, MessageReaction, CollectorOptions, GuildEmoji, ReactionEmoji, ApplicationEmoji, EmojiResolvable, InteractionButtonComponentData, LinkButtonComponentData, StringSelectMenuComponentData, UserSelectMenuComponentData, RoleSelectMenuComponentData, MentionableSelectMenuComponentData, ChannelSelectMenuComponentData, APIMessage, CommandInteraction, InteractionCollector, EmbedBuilder, BaseMessageOptions, WebhookMessageEditOptions, SelectMenuComponentOptionData, MessageComponentInteraction, APIEmbed, JSONEncodable, CollectedInteraction, ModalSubmitInteraction, APIActionRowComponent, APIMessageActionRowComponent, ActionRowData, ActionRowComponentOptions, MessageActionRowComponentBuilder, Guild, InteractionReplyOptions, InteractionUpdateOptions, MessageReplyOptions, MessageEditOptions, Collection, Snowflake, EmbedData, EmbedField, ButtonComponentData, ButtonBuilder, PartialGroupDMChannel, PublicThreadChannel, PrivateThreadChannel, VoiceBasedChannel, BaseInteraction, GuildMember, APIGuildMember, APIInteractionGuildMember, APIInteractionDataResolvedGuildMember, Attachment } from 'discord.js';
+import { Interaction, AutocompleteInteraction, CategoryChannel, DMChannel, DirectoryChannel, PartialDMChannel, NewsChannel, StageChannel, TextChannel, ThreadChannel, VoiceChannel, GuildChannel, Channel, ChatInputCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, JSONEncodable, APIEmbed, Message, EmojiIdentifierResolvable, GuildEmoji, ReactionEmoji, ApplicationEmoji, PartialTextBasedChannelFields, User, CollectorFilter, MessageReaction, CollectorOptions, InteractionButtonComponentData, CollectedInteraction, ModalSubmitInteraction, APIMessage, CommandInteraction, ButtonInteraction, InteractionCollector, LinkButtonComponentData, StringSelectMenuComponentData, UserSelectMenuComponentData, RoleSelectMenuComponentData, MentionableSelectMenuComponentData, ChannelSelectMenuComponentData, Guild, SelectMenuComponentOptionData, MessageComponentInteraction, BaseMessageOptions, WebhookMessageEditOptions, EmbedBuilder, MessageCreateOptions, MessageActionRowComponentBuilder, Collection, Snowflake, EmojiResolvable, StringSelectMenuInteraction, EmbedData, APIActionRowComponent, APIComponentInMessageActionRow, ActionRowData, ActionRowComponentOptions, EmbedField, InteractionReplyOptions, InteractionUpdateOptions, MessageReplyOptions, MessageEditOptions, VoiceBasedChannel, BaseInteraction, ButtonBuilder, PartialGroupDMChannel, GuildMember, APIGuildMember, APIInteractionGuildMember, APIInteractionDataResolvedGuildMember, Attachment, ButtonComponentData, PublicThreadChannel, PrivateThreadChannel } from 'discord.js';
 import { ArgumentTypes, Awaitable, Ctor, Nullish } from '@sapphire/utilities';
 
 type MessageBuilderFileResolvable = NonNullable<MessageCreateOptions['files']>[number];
@@ -643,7 +643,7 @@ type PaginatedMessagePage = ((index: number, pages: PaginatedMessagePage[], hand
  * It can be either a `BaseMessageOptions` object with the `flags` property omitted,
  * or a `WebhookMessageEditOptions` object.
  */
-type PaginatedMessageResolvedPage = Omit<BaseMessageOptions, 'flags'> | WebhookMessageEditOptions;
+type PaginatedMessageResolvedPage = Omit<BaseMessageOptions, 'flags'> | Omit<WebhookMessageEditOptions, 'flags'>;
 /**
  * The type of the custom function that can be set for the {@link PaginatedMessage.selectMenuOptions}
  */
@@ -677,11 +677,11 @@ type PaginatedMessageInteractionUnion = Exclude<CollectedInteraction, ModalSubmi
 /**
  * Represents a union type for components in a paginated message.
  * It can be one of the following types:
- * - `JSONEncodable<APIActionRowComponent<APIMessageActionRowComponent>>`
+ * - `JSONEncodable<APIActionRowComponent<APIComponentInMessageActionRow>>`
  * - `ActionRowData<ActionRowComponentOptions | MessageActionRowComponentBuilder>`
- * - `APIActionRowComponent<APIMessageActionRowComponent>`
+ * - `APIActionRowComponent<APIComponentInMessageActionRow>`
  */
-type PaginatedMessageComponentUnion = JSONEncodable<APIActionRowComponent<APIMessageActionRowComponent>> | ActionRowData<ActionRowComponentOptions | MessageActionRowComponentBuilder> | APIActionRowComponent<APIMessageActionRowComponent>;
+type PaginatedMessageComponentUnion = JSONEncodable<APIActionRowComponent<APIComponentInMessageActionRow>> | ActionRowData<ActionRowComponentOptions | MessageActionRowComponentBuilder> | APIActionRowComponent<APIComponentInMessageActionRow>;
 /**
  * @internal This is a duplicate of the same interface in `@sapphire/plugin-i18next`
  * Duplicated here for the type of the parameters in the functions
@@ -926,7 +926,7 @@ declare class PaginatedMessage {
      * When modifying this it is recommended that the message is set to be ephemeral so only the user that is pressing the buttons can see them.
      * Furthermore, we also recommend setting `allowedMentions: { users: [], roles: [] }`, so you don't have to worry about accidentally pinging anyone.
      *
-     * When setting just a string, we will add `{ ephemeral: true, allowedMentions: { users: [], roles: [] } }` for you.
+     * When setting just a string, we will add `{ flags: MessageFlags.Ephemeral, allowedMentions: { users: [], roles: [] } }` for you.
      *
      * @param targetUser The {@link User} this {@link PaginatedMessage} was intended for.
      * @param interactionUser The {@link User} that actually clicked the button.
@@ -936,7 +936,7 @@ declare class PaginatedMessage {
      *
      * {
      * 	content: `Please stop interacting with the components on this message. They are only for ${userMention(targetUser.id)}.`,
-     * 	ephemeral: true,
+     * 	flags: MessageFlags.Ephemeral,
      * 	allowedMentions: { users: [], roles: [] }
      * }
      * ```
@@ -961,7 +961,7 @@ declare class PaginatedMessage {
      * 	content: `These buttons are only for ${userMention(
      * 		targetUser.id
      * 	)}. Press them as much as you want, but I won't do anything with your clicks.`,
-     * 	ephemeral: true,
+     * 	flags: MessageFlags.Ephemeral,
      * 	allowedMentions: { users: [], roles: [] }
      * });
      * ```
@@ -2090,7 +2090,7 @@ declare function isActionChannelMenu(action: PaginatedMessageAction): action is
 /**
  * Creates partitioned message rows based on the provided components.
  * @param components The array of MessageActionRowComponentBuilder objects.
- * @returns An array of `APIActionRowComponent<APIMessageActionRowComponent>` objects.
+ * @returns An array of `APIActionRowComponent<APIComponentInMessageActionRow>` objects.
  */
 declare function createPartitionedMessageRow(components: MessageActionRowComponentBuilder[]): PaginatedMessageComponentUnion[];
 /**

package/dist/esm/index.d.mts

@@ -1,5 +1,5 @@
 export * from '@sapphire/discord-utilities';
-import { MessageCreateOptions, CategoryChannel, DMChannel, DirectoryChannel, PartialDMChannel, NewsChannel, StageChannel, TextChannel, ThreadChannel, VoiceChannel, GuildChannel, Channel, Message, ChatInputCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, AutocompleteInteraction, StringSelectMenuInteraction, ButtonInteraction, Interaction, PartialTextBasedChannelFields, EmojiIdentifierResolvable, User, CollectorFilter, MessageReaction, CollectorOptions, GuildEmoji, ReactionEmoji, ApplicationEmoji, EmojiResolvable, InteractionButtonComponentData, LinkButtonComponentData, StringSelectMenuComponentData, UserSelectMenuComponentData, RoleSelectMenuComponentData, MentionableSelectMenuComponentData, ChannelSelectMenuComponentData, APIMessage, CommandInteraction, InteractionCollector, EmbedBuilder, BaseMessageOptions, WebhookMessageEditOptions, SelectMenuComponentOptionData, MessageComponentInteraction, APIEmbed, JSONEncodable, CollectedInteraction, ModalSubmitInteraction, APIActionRowComponent, APIMessageActionRowComponent, ActionRowData, ActionRowComponentOptions, MessageActionRowComponentBuilder, Guild, InteractionReplyOptions, InteractionUpdateOptions, MessageReplyOptions, MessageEditOptions, Collection, Snowflake, EmbedData, EmbedField, ButtonComponentData, ButtonBuilder, PartialGroupDMChannel, PublicThreadChannel, PrivateThreadChannel, VoiceBasedChannel, BaseInteraction, GuildMember, APIGuildMember, APIInteractionGuildMember, APIInteractionDataResolvedGuildMember, Attachment } from 'discord.js';
+import { Interaction, AutocompleteInteraction, CategoryChannel, DMChannel, DirectoryChannel, PartialDMChannel, NewsChannel, StageChannel, TextChannel, ThreadChannel, VoiceChannel, GuildChannel, Channel, ChatInputCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, JSONEncodable, APIEmbed, Message, EmojiIdentifierResolvable, GuildEmoji, ReactionEmoji, ApplicationEmoji, PartialTextBasedChannelFields, User, CollectorFilter, MessageReaction, CollectorOptions, InteractionButtonComponentData, CollectedInteraction, ModalSubmitInteraction, APIMessage, CommandInteraction, ButtonInteraction, InteractionCollector, LinkButtonComponentData, StringSelectMenuComponentData, UserSelectMenuComponentData, RoleSelectMenuComponentData, MentionableSelectMenuComponentData, ChannelSelectMenuComponentData, Guild, SelectMenuComponentOptionData, MessageComponentInteraction, BaseMessageOptions, WebhookMessageEditOptions, EmbedBuilder, MessageCreateOptions, MessageActionRowComponentBuilder, Collection, Snowflake, EmojiResolvable, StringSelectMenuInteraction, EmbedData, APIActionRowComponent, APIComponentInMessageActionRow, ActionRowData, ActionRowComponentOptions, EmbedField, InteractionReplyOptions, InteractionUpdateOptions, MessageReplyOptions, MessageEditOptions, VoiceBasedChannel, BaseInteraction, ButtonBuilder, PartialGroupDMChannel, GuildMember, APIGuildMember, APIInteractionGuildMember, APIInteractionDataResolvedGuildMember, Attachment, ButtonComponentData, PublicThreadChannel, PrivateThreadChannel } from 'discord.js';
 import { ArgumentTypes, Awaitable, Ctor, Nullish } from '@sapphire/utilities';
 
 type MessageBuilderFileResolvable = NonNullable<MessageCreateOptions['files']>[number];
@@ -643,7 +643,7 @@ type PaginatedMessagePage = ((index: number, pages: PaginatedMessagePage[], hand
  * It can be either a `BaseMessageOptions` object with the `flags` property omitted,
  * or a `WebhookMessageEditOptions` object.
  */
-type PaginatedMessageResolvedPage = Omit<BaseMessageOptions, 'flags'> | WebhookMessageEditOptions;
+type PaginatedMessageResolvedPage = Omit<BaseMessageOptions, 'flags'> | Omit<WebhookMessageEditOptions, 'flags'>;
 /**
  * The type of the custom function that can be set for the {@link PaginatedMessage.selectMenuOptions}
  */
@@ -677,11 +677,11 @@ type PaginatedMessageInteractionUnion = Exclude<CollectedInteraction, ModalSubmi
 /**
  * Represents a union type for components in a paginated message.
  * It can be one of the following types:
- * - `JSONEncodable<APIActionRowComponent<APIMessageActionRowComponent>>`
+ * - `JSONEncodable<APIActionRowComponent<APIComponentInMessageActionRow>>`
  * - `ActionRowData<ActionRowComponentOptions | MessageActionRowComponentBuilder>`
- * - `APIActionRowComponent<APIMessageActionRowComponent>`
+ * - `APIActionRowComponent<APIComponentInMessageActionRow>`
  */
-type PaginatedMessageComponentUnion = JSONEncodable<APIActionRowComponent<APIMessageActionRowComponent>> | ActionRowData<ActionRowComponentOptions | MessageActionRowComponentBuilder> | APIActionRowComponent<APIMessageActionRowComponent>;
+type PaginatedMessageComponentUnion = JSONEncodable<APIActionRowComponent<APIComponentInMessageActionRow>> | ActionRowData<ActionRowComponentOptions | MessageActionRowComponentBuilder> | APIActionRowComponent<APIComponentInMessageActionRow>;
 /**
  * @internal This is a duplicate of the same interface in `@sapphire/plugin-i18next`
  * Duplicated here for the type of the parameters in the functions
@@ -926,7 +926,7 @@ declare class PaginatedMessage {
      * When modifying this it is recommended that the message is set to be ephemeral so only the user that is pressing the buttons can see them.
      * Furthermore, we also recommend setting `allowedMentions: { users: [], roles: [] }`, so you don't have to worry about accidentally pinging anyone.
      *
-     * When setting just a string, we will add `{ ephemeral: true, allowedMentions: { users: [], roles: [] } }` for you.
+     * When setting just a string, we will add `{ flags: MessageFlags.Ephemeral, allowedMentions: { users: [], roles: [] } }` for you.
      *
      * @param targetUser The {@link User} this {@link PaginatedMessage} was intended for.
      * @param interactionUser The {@link User} that actually clicked the button.
@@ -936,7 +936,7 @@ declare class PaginatedMessage {
      *
      * {
      * 	content: `Please stop interacting with the components on this message. They are only for ${userMention(targetUser.id)}.`,
-     * 	ephemeral: true,
+     * 	flags: MessageFlags.Ephemeral,
      * 	allowedMentions: { users: [], roles: [] }
      * }
      * ```
@@ -961,7 +961,7 @@ declare class PaginatedMessage {
      * 	content: `These buttons are only for ${userMention(
      * 		targetUser.id
      * 	)}. Press them as much as you want, but I won't do anything with your clicks.`,
-     * 	ephemeral: true,
+     * 	flags: MessageFlags.Ephemeral,
      * 	allowedMentions: { users: [], roles: [] }
      * });
      * ```
@@ -2090,7 +2090,7 @@ declare function isActionChannelMenu(action: PaginatedMessageAction): action is
 /**
  * Creates partitioned message rows based on the provided components.
  * @param components The array of MessageActionRowComponentBuilder objects.
- * @returns An array of `APIActionRowComponent<APIMessageActionRowComponent>` objects.
+ * @returns An array of `APIActionRowComponent<APIComponentInMessageActionRow>` objects.
  */
 declare function createPartitionedMessageRow(components: MessageActionRowComponentBuilder[]): PaginatedMessageComponentUnion[];
 /**

package/dist/esm/index.mjs

@@ -1,7 +1,7 @@
 import { EmbedLimits } from '@sapphire/discord-utilities';
 export * from '@sapphire/discord-utilities';
-import { isNullish, isNullishOrEmpty, isNullishOrZero, partition, chunk, isFunction, deepClone, isObject } from '@sapphire/utilities';
-import { ComponentType, ButtonStyle, PermissionsBitField, PermissionFlagsBits, ChannelType, Message, BaseInteraction, GuildMember, ActionRowBuilder, isJSONEncodable, EmbedBuilder, Partials, IntentsBitField, GatewayIntentBits, InteractionCollector, InteractionType, ButtonBuilder, UserSelectMenuBuilder, RoleSelectMenuBuilder, MentionableSelectMenuBuilder, ChannelSelectMenuBuilder, StringSelectMenuBuilder, userMention } from 'discord.js';
+import { isFunction, isNullish, deepClone, isObject, partition, chunk, isNullishOrEmpty, isNullishOrZero } from '@sapphire/utilities';
+import { ComponentType, ButtonStyle, PermissionsBitField, PermissionFlagsBits, isJSONEncodable, EmbedBuilder, Partials, IntentsBitField, GatewayIntentBits, MessageFlags, InteractionCollector, InteractionType, ButtonBuilder, UserSelectMenuBuilder, RoleSelectMenuBuilder, MentionableSelectMenuBuilder, ChannelSelectMenuBuilder, StringSelectMenuBuilder, BaseInteraction, ActionRowBuilder, Message, ChannelType, GuildMember, userMention } from 'discord.js';
 import { Time } from '@sapphire/duration';
 
 var __defProp = Object.defineProperty;
@@ -1506,7 +1506,7 @@ var _PaginatedMessage = class _PaginatedMessage {
       await safelyReplyToInteraction({
         messageOrInteraction,
         interactionEditReplyContent: __privateGet(this, _thisMazeWasNotMeantForYouContent),
-        interactionReplyContent: { ...__privateGet(this, _thisMazeWasNotMeantForYouContent), ephemeral: true },
+        interactionReplyContent: { ...__privateGet(this, _thisMazeWasNotMeantForYouContent), flags: MessageFlags.Ephemeral },
         componentUpdateContent: __privateGet(this, _thisMazeWasNotMeantForYouContent),
         messageMethod: "reply",
         messageMethodContent: __privateGet(this, _thisMazeWasNotMeantForYouContent)
@@ -1751,7 +1751,7 @@ var _PaginatedMessage = class _PaginatedMessage {
           await safelyReplyToInteraction({
             messageOrInteraction: interaction,
             interactionEditReplyContent: updateOptions,
-            interactionReplyContent: { ...__privateGet(this, _thisMazeWasNotMeantForYouContent), ephemeral: true },
+            interactionReplyContent: { ...__privateGet(this, _thisMazeWasNotMeantForYouContent), flags: MessageFlags.Ephemeral },
             componentUpdateContent: updateOptions
           });
         }
@@ -1763,7 +1763,7 @@ var _PaginatedMessage = class _PaginatedMessage {
         this.resolvePaginatedMessageInternationalizationContext(interaction, targetUser)
       );
       await interaction.reply(
-        isObject(interactionReplyOptions) ? interactionReplyOptions : { content: interactionReplyOptions, ephemeral: true, allowedMentions: { users: [], roles: [] } }
+        isObject(interactionReplyOptions) ? interactionReplyOptions : { content: interactionReplyOptions, flags: MessageFlags.Ephemeral, allowedMentions: { users: [], roles: [] } }
       );
     }
   }
@@ -1780,7 +1780,7 @@ var _PaginatedMessage = class _PaginatedMessage {
       void safelyReplyToInteraction({
         messageOrInteraction: this.response,
         interactionEditReplyContent: { components: [] },
-        interactionReplyContent: { ...__privateGet(this, _thisMazeWasNotMeantForYouContent), ephemeral: true },
+        interactionReplyContent: { ...__privateGet(this, _thisMazeWasNotMeantForYouContent), flags: MessageFlags.Ephemeral },
         componentUpdateContent: { components: [] },
         messageMethod: "edit",
         messageMethodContent: { components: [] }
@@ -2082,7 +2082,7 @@ __publicField(_PaginatedMessage, "selectMenuOptions", /* @__PURE__ */ __name((pa
  * When modifying this it is recommended that the message is set to be ephemeral so only the user that is pressing the buttons can see them.
  * Furthermore, we also recommend setting `allowedMentions: { users: [], roles: [] }`, so you don't have to worry about accidentally pinging anyone.
  *
- * When setting just a string, we will add `{ ephemeral: true, allowedMentions: { users: [], roles: [] } }` for you.
+ * When setting just a string, we will add `{ flags: MessageFlags.Ephemeral, allowedMentions: { users: [], roles: [] } }` for you.
  *
  * @param targetUser The {@link User} this {@link PaginatedMessage} was intended for.
  * @param interactionUser The {@link User} that actually clicked the button.
@@ -2092,7 +2092,7 @@ __publicField(_PaginatedMessage, "selectMenuOptions", /* @__PURE__ */ __name((pa
  *
  * {
  * 	content: `Please stop interacting with the components on this message. They are only for ${userMention(targetUser.id)}.`,
- * 	ephemeral: true,
+ * 	flags: MessageFlags.Ephemeral,
  * 	allowedMentions: { users: [], roles: [] }
  * }
  * ```
@@ -2117,14 +2117,14 @@ __publicField(_PaginatedMessage, "selectMenuOptions", /* @__PURE__ */ __name((pa
  * 	content: `These buttons are only for ${userMention(
  * 		targetUser.id
  * 	)}. Press them as much as you want, but I won't do anything with your clicks.`,
- * 	ephemeral: true,
+ * 	flags: MessageFlags.Ephemeral,
  * 	allowedMentions: { users: [], roles: [] }
  * });
  * ```
  */
 __publicField(_PaginatedMessage, "wrongUserInteractionReply", /* @__PURE__ */ __name((targetUser) => ({
   content: `Please stop interacting with the components on this message. They are only for ${userMention(targetUser.id)}.`,
-  ephemeral: true,
+  flags: MessageFlags.Ephemeral,
   allowedMentions: { users: [], roles: [] }
 }), "wrongUserInteractionReply"));
 var PaginatedMessage = _PaginatedMessage;