@discordjs/builders 2.0.0-djs-file-upload.1761302390-5ae769c9e → 2.0.0-pr-11006.1765450224-e636950b2

package/dist/index.mjs

@@ -95,15 +95,15 @@ import { Locale } from "discord-api-types/v10";
 import { z as z2 } from "zod";
 var idPredicate = z2.int().min(0).max(2147483647).optional();
 var customIdPredicate = z2.string().min(1).max(100);
+var snowflakePredicate = z2.string().regex(/^(?:0|[1-9]\d*)$/);
 var memberPermissionsPredicate = z2.coerce.bigint();
 var localeMapPredicate = z2.strictObject(
   Object.fromEntries(Object.values(Locale).map((loc) => [loc, z2.string().optional()]))
 );
 
 // src/components/Assertions.ts
-var labelPredicate = z3.string().min(1).max(80);
 var emojiPredicate = z3.strictObject({
-  id: z3.string().optional(),
+  id: snowflakePredicate.optional(),
   name: z3.string().min(2).max(32).optional(),
   animated: z3.boolean().optional()
 }).refine((data) => data.id !== void 0 || data.name !== void 0, {
@@ -113,24 +113,29 @@ var buttonPredicateBase = z3.strictObject({
   type: z3.literal(ComponentType.Button),
   disabled: z3.boolean().optional()
 });
+var buttonLabelPredicate = z3.string().min(1).max(80);
 var buttonCustomIdPredicateBase = buttonPredicateBase.extend({
   custom_id: customIdPredicate,
   emoji: emojiPredicate.optional(),
-  label: labelPredicate
+  label: buttonLabelPredicate.optional()
+}).refine((data) => data.emoji !== void 0 || data.label !== void 0, {
+  message: "Buttons with a custom id must have either an emoji or a label."
 });
-var buttonPrimaryPredicate = buttonCustomIdPredicateBase.extend({ style: z3.literal(ButtonStyle.Primary) });
-var buttonSecondaryPredicate = buttonCustomIdPredicateBase.extend({ style: z3.literal(ButtonStyle.Secondary) });
-var buttonSuccessPredicate = buttonCustomIdPredicateBase.extend({ style: z3.literal(ButtonStyle.Success) });
-var buttonDangerPredicate = buttonCustomIdPredicateBase.extend({ style: z3.literal(ButtonStyle.Danger) });
+var buttonPrimaryPredicate = buttonCustomIdPredicateBase.safeExtend({ style: z3.literal(ButtonStyle.Primary) });
+var buttonSecondaryPredicate = buttonCustomIdPredicateBase.safeExtend({ style: z3.literal(ButtonStyle.Secondary) });
+var buttonSuccessPredicate = buttonCustomIdPredicateBase.safeExtend({ style: z3.literal(ButtonStyle.Success) });
+var buttonDangerPredicate = buttonCustomIdPredicateBase.safeExtend({ style: z3.literal(ButtonStyle.Danger) });
 var buttonLinkPredicate = buttonPredicateBase.extend({
   style: z3.literal(ButtonStyle.Link),
   url: z3.url({ protocol: /^(?:https?|discord)$/ }).max(512),
   emoji: emojiPredicate.optional(),
-  label: labelPredicate
+  label: buttonLabelPredicate.optional()
+}).refine((data) => data.emoji !== void 0 || data.label !== void 0, {
+  message: "Link buttons must have either an emoji or a label."
 });
 var buttonPremiumPredicate = buttonPredicateBase.extend({
   style: z3.literal(ButtonStyle.Premium),
-  sku_id: z3.string()
+  sku_id: snowflakePredicate
 });
 var buttonPredicate = z3.discriminatedUnion("style", [
   buttonLinkPredicate,
@@ -151,21 +156,21 @@ var selectMenuBasePredicate = z3.object({
 var selectMenuChannelPredicate = selectMenuBasePredicate.extend({
   type: z3.literal(ComponentType.ChannelSelect),
   channel_types: z3.enum(ChannelType).array().optional(),
-  default_values: z3.object({ id: z3.string(), type: z3.literal(SelectMenuDefaultValueType.Channel) }).array().max(25).optional()
+  default_values: z3.object({ id: snowflakePredicate, type: z3.literal(SelectMenuDefaultValueType.Channel) }).array().max(25).optional()
 });
 var selectMenuMentionablePredicate = selectMenuBasePredicate.extend({
   type: z3.literal(ComponentType.MentionableSelect),
   default_values: z3.object({
-    id: z3.string(),
+    id: snowflakePredicate,
     type: z3.literal([SelectMenuDefaultValueType.Role, SelectMenuDefaultValueType.User])
   }).array().max(25).optional()
 });
 var selectMenuRolePredicate = selectMenuBasePredicate.extend({
   type: z3.literal(ComponentType.RoleSelect),
-  default_values: z3.object({ id: z3.string(), type: z3.literal(SelectMenuDefaultValueType.Role) }).array().max(25).optional()
+  default_values: z3.object({ id: snowflakePredicate, type: z3.literal(SelectMenuDefaultValueType.Role) }).array().max(25).optional()
 });
 var selectMenuStringOptionPredicate = z3.object({
-  label: labelPredicate,
+  label: z3.string().min(1).max(100),
   value: z3.string().min(1).max(100),
   description: z3.string().min(1).max(100).optional(),
   emoji: emojiPredicate.optional(),
@@ -203,7 +208,7 @@ var selectMenuStringPredicate = selectMenuBasePredicate.extend({
 });
 var selectMenuUserPredicate = selectMenuBasePredicate.extend({
   type: z3.literal(ComponentType.UserSelect),
-  default_values: z3.object({ id: z3.string(), type: z3.literal(SelectMenuDefaultValueType.User) }).array().max(25).optional()
+  default_values: z3.object({ id: snowflakePredicate, type: z3.literal(SelectMenuDefaultValueType.User) }).array().max(25).optional()
 });
 var actionRowPredicate = z3.object({
   id: idPredicate,
@@ -390,7 +395,7 @@ import { ComponentType as ComponentType5 } from "discord-api-types/v10";
 import { z as z4 } from "zod";
 var fileUploadPredicate = z4.object({
   type: z4.literal(ComponentType5.FileUpload),
-  id: z4.int().min(0).optional(),
+  id: idPredicate,
   custom_id: customIdPredicate,
   min_values: z4.int().min(0).max(10).optional(),
   max_values: z4.int().min(1).max(10).optional(),
@@ -461,7 +466,7 @@ var FileUploadBuilder = class extends ComponentBuilder {
   /**
    * Sets the maximum number of file uploads required.
    *
-   * @param maxValues - The maximum values that must be uploaded
+   * @param maxValues - The maximum values that can be uploaded
    */
   setMaxValues(maxValues) {
     this.data.max_values = maxValues;
@@ -562,9 +567,9 @@ var BaseSelectMenuBuilder = class extends ComponentBuilder {
     return this;
   }
   /**
-   * Sets the maximum values that must be selected in the select menu.
+   * Sets the maximum values that can be selected in the select menu.
    *
-   * @param maxValues - The maximum values that must be selected
+   * @param maxValues - The maximum values that can be selected
    */
   setMaxValues(maxValues) {
     this.data.max_values = maxValues;
@@ -2512,7 +2517,7 @@ __name(resolveAccessoryComponent, "resolveAccessoryComponent");
 // src/components/label/Assertions.ts
 import { ComponentType as ComponentType24 } from "discord-api-types/v10";
 import { z as z7 } from "zod";
-var labelPredicate2 = z7.object({
+var labelPredicate = z7.object({
   id: idPredicate,
   type: z7.literal(ComponentType24.Label),
   label: z7.string().min(1).max(45),
@@ -2665,7 +2670,7 @@ var LabelBuilder = class extends ComponentBuilder {
       // The label predicate validates the component.
       component: component?.toJSON(false)
     };
-    validate(labelPredicate2, data, validationOverride);
+    validate(labelPredicate, data, validationOverride);
     return data;
   }
 };
@@ -2995,8 +3000,8 @@ var numberOptionPredicate = z8.object({
   ...numericMixinNumberOptionPredicate.shape
 }).and(autocompleteOrNumberChoicesMixinOptionPredicate);
 var stringOptionPredicate = basicOptionPredicate.extend({
-  max_length: z8.number().min(0).max(6e3).optional(),
-  min_length: z8.number().min(1).max(6e3).optional()
+  max_length: z8.number().min(1).max(6e3).optional(),
+  min_length: z8.number().min(0).max(6e3).optional()
 }).and(autocompleteOrStringChoicesMixinOptionPredicate);
 var baseChatInputCommandPredicate = sharedNameAndDescriptionPredicate.extend({
   contexts: z8.array(z8.enum(InteractionContextType)).optional(),
@@ -3006,8 +3011,12 @@ var baseChatInputCommandPredicate = sharedNameAndDescriptionPredicate.extend({
 });
 var chatInputCommandOptionsPredicate = z8.union([
   z8.object({ type: basicOptionTypesPredicate }).array(),
-  z8.object({ type: z8.literal(ApplicationCommandOptionType.Subcommand) }).array(),
-  z8.object({ type: z8.literal(ApplicationCommandOptionType.SubcommandGroup) }).array()
+  z8.object({
+    type: z8.union([
+      z8.literal(ApplicationCommandOptionType.Subcommand),
+      z8.literal(ApplicationCommandOptionType.SubcommandGroup)
+    ])
+  }).array()
 ]);
 var chatInputCommandPredicate = baseChatInputCommandPredicate.extend({
   options: chatInputCommandOptionsPredicate.optional()
@@ -3658,7 +3667,7 @@ var modalPredicate = z10.object({
       type: z10.literal(ComponentType26.ActionRow),
       components: z10.object({ type: z10.literal(ComponentType26.TextInput) }).array().length(1)
     }),
-    labelPredicate2,
+    labelPredicate,
     textDisplayPredicate
   ]).array().min(1).max(5)
 });
@@ -3782,15 +3791,8 @@ var ModalBuilder = class {
 };
 
 // src/messages/embed/Assertions.ts
+import { embedLength } from "@discordjs/util";
 import { z as z11 } from "zod";
-
-// src/util/componentUtil.ts
-function embedLength(data) {
-  return (data.title?.length ?? 0) + (data.description?.length ?? 0) + (data.fields?.reduce((prev, curr) => prev + curr.name.length + curr.value.length, 0) ?? 0) + (data.footer?.text.length ?? 0) + (data.author?.name.length ?? 0);
-}
-__name(embedLength, "embedLength");
-
-// src/messages/embed/Assertions.ts
 var namePredicate3 = z11.string().max(256);
 var URLPredicate = z11.url({ protocol: /^https?$/ });
 var URLWithAttachmentProtocolPredicate = z11.url({ protocol: /^(?:https?|attachment)$/ });
@@ -4645,10 +4647,19 @@ var PollBuilder = class {
 };
 
 // src/messages/Assertions.ts
+import { Buffer as Buffer2 } from "buffer";
 import { AllowedMentionsTypes, ComponentType as ComponentType27, MessageFlags, MessageReferenceType } from "discord-api-types/v10";
 import { z as z13 } from "zod";
+var fileKeyRegex = /^files\[(?<placeholder>\d+?)]$/;
+var rawFilePredicate = z13.object({
+  data: z13.union([z13.instanceof(Buffer2), z13.instanceof(Uint8Array), z13.string()]),
+  name: z13.string().min(1),
+  contentType: z13.string().optional(),
+  key: z13.string().regex(fileKeyRegex).optional()
+});
 var attachmentPredicate = z13.object({
-  id: z13.union([z13.string(), z13.number()]),
+  // As a string it only makes sense for edits when we do have an attachment snowflake
+  id: z13.union([snowflakePredicate, z13.number()]),
   description: z13.string().max(1024).optional(),
   duration_secs: z13.number().max(2 ** 31 - 1).optional(),
   filename: z13.string().max(1024).optional(),
@@ -4734,6 +4745,11 @@ var messageComponentsV2Predicate = baseMessagePredicate.extend({
   poll: z13.null().optional()
 });
 var messagePredicate = z13.union([messageNoComponentsV2Predicate, messageComponentsV2Predicate]);
+var fileBodyMessagePredicate = z13.object({
+  body: messagePredicate,
+  // No min length to support message edits
+  files: rawFilePredicate.array().max(10)
+});
 
 // src/messages/AllowedMentions.ts
 var AllowedMentionsBuilder = class {
@@ -4918,13 +4934,29 @@ var AttachmentBuilder = class {
    * The API data associated with this attachment.
    */
   data;
+  /**
+   * This data is not included in the output of `toJSON()`. For this class specifically, this refers to binary data
+   * that will wind up being included in the multipart/form-data request, if used with the `MessageBuilder`.
+   * To retrieve this data, use {@link getRawFile}.
+   *
+   * @remarks This cannot be set via the constructor, primarily because of the behavior described
+   * {@link https://discord.com/developers/docs/reference#editing-message-attachments | here}.
+   * That is, when editing a message's attachments, you should only be providing file data for new attachments.
+   */
+  fileData;
   /**
    * Creates a new attachment builder.
    *
    * @param data - The API data to create this attachment with
+   * @example
+   * ```ts
+   * const attachment = new AttachmentBuilder().setId(1).setFileData(':)').setFilename('smiley.txt')
+   * ```
+   * @remarks Please note that the `id` field is required, it's rather easy to miss!
    */
   constructor(data = {}) {
     this.data = structuredClone(data);
+    this.fileData = {};
   }
   /**
    * Sets the id of the attachment.
@@ -4983,6 +5015,54 @@ var AttachmentBuilder = class {
     this.data.filename = void 0;
     return this;
   }
+  /**
+   * Sets the file data to upload with this attachment.
+   *
+   * @param data - The file data
+   * @remarks Note that this data is NOT included in the {@link toJSON} output. To retrieve it, use {@link getRawFile}.
+   */
+  setFileData(data) {
+    this.fileData.data = data;
+    return this;
+  }
+  /**
+   * Clears the file data from this attachment.
+   */
+  clearFileData() {
+    this.fileData.data = void 0;
+    return this;
+  }
+  /**
+   * Sets the content type of the file data to upload with this attachment.
+   *
+   * @remarks Note that this data is NOT included in the {@link toJSON} output. To retrieve it, use {@link getRawFile}.
+   */
+  setFileContentType(contentType) {
+    this.fileData.contentType = contentType;
+    return this;
+  }
+  /**
+   * Clears the content type of the file data from this attachment.
+   */
+  clearFileContentType() {
+    this.fileData.contentType = void 0;
+    return this;
+  }
+  /**
+   * Converts this attachment to a {@link RawFile} for uploading.
+   *
+   * @returns A {@link RawFile} object, or `undefined` if no file data is set
+   */
+  getRawFile() {
+    if (!this.fileData?.data) {
+      return;
+    }
+    return {
+      ...this.fileData,
+      name: this.data.filename,
+      key: this.data.id === void 0 ? void 0 : `files[${this.data.id}]`
+    };
+  }
   /**
    * Sets the title of this attachment.
    *
@@ -5287,7 +5367,7 @@ var MessageBuilder = class {
    *
    * @param allowedMentions - The allowed mentions to set
    */
-  setAllowedMentions(allowedMentions) {
+  setAllowedMentions(allowedMentions = new AllowedMentionsBuilder()) {
     this.data.allowed_mentions = resolveBuilder(allowedMentions, AllowedMentionsBuilder);
     return this;
   }
@@ -5620,10 +5700,31 @@ var MessageBuilder = class {
     validate(messagePredicate, data, validationOverride);
     return data;
   }
+  /**
+   * Serializes this builder to both JSON body and file data for multipart/form-data requests.
+   *
+   * @param validationOverride - Force validation to run/not run regardless of your global preference
+   * @remarks
+   * This method extracts file data from attachments that have files set via {@link AttachmentBuilder.setFileData}.
+   * The returned body includes attachment metadata, while files contains the binary data for upload.
+   */
+  toFileBody(validationOverride) {
+    const body = this.toJSON(false);
+    const files = [];
+    for (const attachment of this.data.attachments) {
+      const rawFile = attachment.getRawFile();
+      if (rawFile?.data || rawFile?.contentType) {
+        files.push(rawFile);
+      }
+    }
+    const combined = { body, files };
+    validate(fileBodyMessagePredicate, combined, validationOverride);
+    return combined;
+  }
 };
 
 // src/index.ts
-var version = "2.0.0-djs-file-upload.1761302390-5ae769c9e";
+var version = "2.0.0-pr-11006.1765450224-e636950b2";
 export {
   ActionRowBuilder,
   AllowedMentionsBuilder,
@@ -5711,16 +5812,16 @@ export {
   embedAuthorPredicate,
   embedFieldPredicate,
   embedFooterPredicate,
-  embedLength,
   embedPredicate,
   emojiPredicate,
   enableValidators,
+  fileBodyMessagePredicate,
   filePredicate,
   fileUploadPredicate,
   idPredicate,
   integerOptionPredicate,
   isValidationEnabled,
-  labelPredicate2 as labelPredicate,
+  labelPredicate,
   localeMapPredicate,
   mediaGalleryItemPredicate,
   mediaGalleryPredicate,
@@ -5735,6 +5836,7 @@ export {
   pollAnswerPredicate,
   pollPredicate,
   pollQuestionPredicate,
+  rawFilePredicate,
   resolveAccessoryComponent,
   resolveBuilder,
   sectionPredicate,
@@ -5745,6 +5847,7 @@ export {
   selectMenuStringPredicate,
   selectMenuUserPredicate,
   separatorPredicate,
+  snowflakePredicate,
   stringOptionPredicate,
   textDisplayPredicate,
   textInputPredicate,