@magicyan/discord 1.6.2 → 1.6.3

package/dist/constants/separator.cjs

@@ -2,7 +2,7 @@
 
 const separator = require('../functions/components/separator.cjs');
 
-const Separator = {
+const Separator = Object.freeze({
   /**
    * Default separator with small spacing and visible divider.
    * Equivalent to: `createSeparator()`
@@ -31,6 +31,6 @@ const Separator = {
   get Hidden() {
     return separator.createSeparator(false, false);
   }
-};
+});
 
 exports.Separator = Separator;

package/dist/constants/separator.mjs

@@ -1,6 +1,6 @@
 import { createSeparator } from '../functions/components/separator.mjs';
 
-const Separator = {
+const Separator = Object.freeze({
   /**
    * Default separator with small spacing and visible divider.
    * Equivalent to: `createSeparator()`
@@ -29,6 +29,6 @@ const Separator = {
   get Hidden() {
     return createSeparator(false, false);
   }
-};
+});
 
 export { Separator };

package/dist/functions/components/upload.cjs

@@ -1,19 +1,38 @@
 'use strict';
 
+const core = require('@magicyan/core');
 const discord_js = require('discord.js');
 
-function createFileUpload(arg) {
-  if (typeof arg === "string")
+function createFileUpload(arg, argB, argC, argD) {
+  if (typeof arg === "object") {
     return new discord_js.FileUploadBuilder({
-      custom_id: arg
+      custom_id: arg.customId,
+      max_values: arg.maxValues,
+      min_values: arg.minValues,
+      required: arg.required,
+      id: arg.id
     });
-  const { customId, maxValues, minValues, ...data } = arg;
-  return new discord_js.FileUploadBuilder({
-    custom_id: customId,
-    max_values: maxValues,
-    min_values: minValues,
-    ...data
-  });
+  }
+  let custom_id = arg;
+  let required;
+  let max_values;
+  let min_values;
+  if (typeof argB === "boolean") {
+    required = argB;
+    max_values = argC;
+    min_values = argD;
+  } else if (typeof argB === "number") {
+    max_values = argB;
+    min_values = argC;
+  }
+  const data = { custom_id };
+  if (core.isDefined(required))
+    data.required = required;
+  if (core.isDefined(max_values))
+    data.max_values = max_values;
+  if (core.isDefined(min_values))
+    data.min_values = min_values;
+  return new discord_js.FileUploadBuilder(data);
 }
 
 exports.createFileUpload = createFileUpload;

package/dist/functions/components/upload.mjs

@@ -1,17 +1,36 @@
+import { isDefined } from '@magicyan/core';
 import { FileUploadBuilder } from 'discord.js';
 
-function createFileUpload(arg) {
-  if (typeof arg === "string")
+function createFileUpload(arg, argB, argC, argD) {
+  if (typeof arg === "object") {
     return new FileUploadBuilder({
-      custom_id: arg
+      custom_id: arg.customId,
+      max_values: arg.maxValues,
+      min_values: arg.minValues,
+      required: arg.required,
+      id: arg.id
     });
-  const { customId, maxValues, minValues, ...data } = arg;
-  return new FileUploadBuilder({
-    custom_id: customId,
-    max_values: maxValues,
-    min_values: minValues,
-    ...data
-  });
+  }
+  let custom_id = arg;
+  let required;
+  let max_values;
+  let min_values;
+  if (typeof argB === "boolean") {
+    required = argB;
+    max_values = argC;
+    min_values = argD;
+  } else if (typeof argB === "number") {
+    max_values = argB;
+    min_values = argC;
+  }
+  const data = { custom_id };
+  if (isDefined(required))
+    data.required = required;
+  if (isDefined(max_values))
+    data.max_values = max_values;
+  if (isDefined(min_values))
+    data.min_values = min_values;
+  return new FileUploadBuilder(data);
 }
 
 export { createFileUpload };

package/dist/index.d.cts

@@ -34,7 +34,7 @@ declare enum EmbedLimit {
 /**
  * Predefined separator spacing variants for quick use.
  */
-declare const Separator: {
+declare const Separator: Readonly<{
     /**
      * Default separator with small spacing and visible divider.
      * Equivalent to: `createSeparator()`
@@ -55,7 +55,7 @@ declare const Separator: {
      * Equivalent to: `createSeparator(false, false)`
      */
     readonly Hidden: discord_js.SeparatorBuilder;
-};
+}>;
 
 type GuildChannelType = Exclude<ChannelType, ChannelType.DM>;
 type FindChannelFilter<T extends GuildChannelType> = (channel: GetChannelType<T>) => boolean;
@@ -725,8 +725,60 @@ interface FileUploadData {
     required?: boolean;
     id?: number;
 }
+/**
+ * Creates a file upload component using an object configuration.
+ *
+ * This overload is useful when you already have your file upload settings grouped in an object.
+ * Each field corresponds directly to the {@link APIFileUploadComponent} properties.
+ *
+ * @param data - The configuration object containing the upload settings.
+ * @returns A new {@link FileUploadBuilder} instance configured with the provided data.
+ *
+ * @example
+ * ```ts
+ * const upload = createFileUpload({
+ *   customId: "images",
+ *   required: true,
+ *   maxValues: 5,
+ *   minValues: 1
+ * });
+ * ```
+ */
 declare function createFileUpload(data: FileUploadData): FileUploadBuilder;
-declare function createFileUpload(customId: string): FileUploadBuilder;
+/**
+ * Creates a file upload component using explicit parameters.
+ *
+ * Use this overload when you want to control the required flag and the upload limits separately.
+ *
+ * @param customId - The custom identifier for the file upload component.
+ * @param required - Whether the file upload is required before submitting.
+ * @param maxValues - The maximum number of files that can be uploaded.
+ * @param minValues - The minimum number of files required to upload.
+ * @returns A new {@link FileUploadBuilder} instance configured with the provided values.
+ *
+ * @example
+ * ```ts
+ * const upload = createFileUpload("files", true, 5, 1);
+ * ```
+ */
+declare function createFileUpload(customId: string, required?: boolean, maxValues?: number, minValues?: number): FileUploadBuilder;
+/**
+ * Creates a file upload component specifying only numeric limits.
+ *
+ * Use this overload when you only need to define upload limits,
+ * and the `required` flag should remain optional.
+ *
+ * @param customId - The custom identifier for the file upload component.
+ * @param maxValues - The maximum number of files that can be uploaded.
+ * @param minValues - The minimum number of files required to upload.
+ * @returns A new {@link FileUploadBuilder} instance configured with the provided values.
+ *
+ * @example
+ * ```ts
+ * const upload = createFileUpload("images", 10, 2);
+ * ```
+ */
+declare function createFileUpload(customId: string, maxValues?: number, minValues?: number): FileUploadBuilder;
 
 type EmbedPlusAssetData = string | Attachment | AttachmentBuilder | EmbedAssetData | undefined | null;
 type EmbedAssetOptions = Omit<EmbedAssetData, "url">;

package/dist/index.d.mts

@@ -34,7 +34,7 @@ declare enum EmbedLimit {
 /**
  * Predefined separator spacing variants for quick use.
  */
-declare const Separator: {
+declare const Separator: Readonly<{
     /**
      * Default separator with small spacing and visible divider.
      * Equivalent to: `createSeparator()`
@@ -55,7 +55,7 @@ declare const Separator: {
      * Equivalent to: `createSeparator(false, false)`
      */
     readonly Hidden: discord_js.SeparatorBuilder;
-};
+}>;
 
 type GuildChannelType = Exclude<ChannelType, ChannelType.DM>;
 type FindChannelFilter<T extends GuildChannelType> = (channel: GetChannelType<T>) => boolean;
@@ -725,8 +725,60 @@ interface FileUploadData {
     required?: boolean;
     id?: number;
 }
+/**
+ * Creates a file upload component using an object configuration.
+ *
+ * This overload is useful when you already have your file upload settings grouped in an object.
+ * Each field corresponds directly to the {@link APIFileUploadComponent} properties.
+ *
+ * @param data - The configuration object containing the upload settings.
+ * @returns A new {@link FileUploadBuilder} instance configured with the provided data.
+ *
+ * @example
+ * ```ts
+ * const upload = createFileUpload({
+ *   customId: "images",
+ *   required: true,
+ *   maxValues: 5,
+ *   minValues: 1
+ * });
+ * ```
+ */
 declare function createFileUpload(data: FileUploadData): FileUploadBuilder;
-declare function createFileUpload(customId: string): FileUploadBuilder;
+/**
+ * Creates a file upload component using explicit parameters.
+ *
+ * Use this overload when you want to control the required flag and the upload limits separately.
+ *
+ * @param customId - The custom identifier for the file upload component.
+ * @param required - Whether the file upload is required before submitting.
+ * @param maxValues - The maximum number of files that can be uploaded.
+ * @param minValues - The minimum number of files required to upload.
+ * @returns A new {@link FileUploadBuilder} instance configured with the provided values.
+ *
+ * @example
+ * ```ts
+ * const upload = createFileUpload("files", true, 5, 1);
+ * ```
+ */
+declare function createFileUpload(customId: string, required?: boolean, maxValues?: number, minValues?: number): FileUploadBuilder;
+/**
+ * Creates a file upload component specifying only numeric limits.
+ *
+ * Use this overload when you only need to define upload limits,
+ * and the `required` flag should remain optional.
+ *
+ * @param customId - The custom identifier for the file upload component.
+ * @param maxValues - The maximum number of files that can be uploaded.
+ * @param minValues - The minimum number of files required to upload.
+ * @returns A new {@link FileUploadBuilder} instance configured with the provided values.
+ *
+ * @example
+ * ```ts
+ * const upload = createFileUpload("images", 10, 2);
+ * ```
+ */
+declare function createFileUpload(customId: string, maxValues?: number, minValues?: number): FileUploadBuilder;
 
 type EmbedPlusAssetData = string | Attachment | AttachmentBuilder | EmbedAssetData | undefined | null;
 type EmbedAssetOptions = Omit<EmbedAssetData, "url">;

package/dist/index.d.ts

@@ -34,7 +34,7 @@ declare enum EmbedLimit {
 /**
  * Predefined separator spacing variants for quick use.
  */
-declare const Separator: {
+declare const Separator: Readonly<{
     /**
      * Default separator with small spacing and visible divider.
      * Equivalent to: `createSeparator()`
@@ -55,7 +55,7 @@ declare const Separator: {
      * Equivalent to: `createSeparator(false, false)`
      */
     readonly Hidden: discord_js.SeparatorBuilder;
-};
+}>;
 
 type GuildChannelType = Exclude<ChannelType, ChannelType.DM>;
 type FindChannelFilter<T extends GuildChannelType> = (channel: GetChannelType<T>) => boolean;
@@ -725,8 +725,60 @@ interface FileUploadData {
     required?: boolean;
     id?: number;
 }
+/**
+ * Creates a file upload component using an object configuration.
+ *
+ * This overload is useful when you already have your file upload settings grouped in an object.
+ * Each field corresponds directly to the {@link APIFileUploadComponent} properties.
+ *
+ * @param data - The configuration object containing the upload settings.
+ * @returns A new {@link FileUploadBuilder} instance configured with the provided data.
+ *
+ * @example
+ * ```ts
+ * const upload = createFileUpload({
+ *   customId: "images",
+ *   required: true,
+ *   maxValues: 5,
+ *   minValues: 1
+ * });
+ * ```
+ */
 declare function createFileUpload(data: FileUploadData): FileUploadBuilder;
-declare function createFileUpload(customId: string): FileUploadBuilder;
+/**
+ * Creates a file upload component using explicit parameters.
+ *
+ * Use this overload when you want to control the required flag and the upload limits separately.
+ *
+ * @param customId - The custom identifier for the file upload component.
+ * @param required - Whether the file upload is required before submitting.
+ * @param maxValues - The maximum number of files that can be uploaded.
+ * @param minValues - The minimum number of files required to upload.
+ * @returns A new {@link FileUploadBuilder} instance configured with the provided values.
+ *
+ * @example
+ * ```ts
+ * const upload = createFileUpload("files", true, 5, 1);
+ * ```
+ */
+declare function createFileUpload(customId: string, required?: boolean, maxValues?: number, minValues?: number): FileUploadBuilder;
+/**
+ * Creates a file upload component specifying only numeric limits.
+ *
+ * Use this overload when you only need to define upload limits,
+ * and the `required` flag should remain optional.
+ *
+ * @param customId - The custom identifier for the file upload component.
+ * @param maxValues - The maximum number of files that can be uploaded.
+ * @param minValues - The minimum number of files required to upload.
+ * @returns A new {@link FileUploadBuilder} instance configured with the provided values.
+ *
+ * @example
+ * ```ts
+ * const upload = createFileUpload("images", 10, 2);
+ * ```
+ */
+declare function createFileUpload(customId: string, maxValues?: number, minValues?: number): FileUploadBuilder;
 
 type EmbedPlusAssetData = string | Attachment | AttachmentBuilder | EmbedAssetData | undefined | null;
 type EmbedAssetOptions = Omit<EmbedAssetData, "url">;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magicyan/discord",
-  "version": "1.6.2",
+  "version": "1.6.3",
   "description": "Simple functions to facilitate discord bot development",
   "license": "MIT",
   "type": "module",
@@ -39,7 +39,7 @@
     "test": "vitest"
   },
   "peerDependencies": {
-    "discord.js": "^14.24.0"
+    "discord.js": "^14.24.2"
   },
   "devDependencies": {
     "@magicyan/config": "*",