@open-discord-bots/framework 0.4.6 → 0.4.8

package/dist/api/main.js

@@ -44,7 +44,7 @@ export class ODMain {
     constructor(managers, project) {
         this.project = project;
         this.versions = managers.versions;
-        this.versions.add(ODVersion.fromString("opendiscord:api", "v0.4.6"));
+        this.versions.add(ODVersion.fromString("opendiscord:api", "v0.4.8"));
         this.versions.add(ODVersion.fromString("opendiscord:livestatus", "v2.0.0"));
         this.debugfile = managers.debugfile;
         this.console = managers.console;

package/dist/api/modules/component.d.ts

@@ -2,7 +2,7 @@ import { ODId, ODValidId, ODManagerData, ODNoGeneric, ODManager, ODValidButtonCo
 import * as discord from "discord.js";
 import { ODWorkerManager, ODWorkerCallback } from "./worker.js";
 import { ODDebugger } from "./console.js";
-import { ODMessage, ODMessageInstance } from "./builder.js";
+import { ODMessage, ODMessageInstance, ODModalBuildResult } from "./builder.js";
 /**## ODComponentFactoryInstance `class`
  * An Open Discord component factory instance.
  *
@@ -395,9 +395,12 @@ export type ODValidModalComponents = ODLabelComponent | ODTextComponent;
  * A modal builder with **components v2** support.
  * Add questions, select menu's & labels to this modal using `addComponent()`.
  */
-export declare class ODModalComponent extends ODGroupComponent<ODModalComponentData, ODValidModalComponents, discord.ModalBuilder> {
+export declare class ODModalComponent extends ODGroupComponent<ODModalComponentData, ODValidModalComponents, ODModalBuildResult> {
     constructor(id: ODValidId, data?: Partial<ODModalComponentData>);
-    build(): Promise<discord.ModalBuilder>;
+    build(): Promise<{
+        id: ODId;
+        modal: discord.ModalBuilder;
+    }>;
     /**Set the title of the modal. */
     setTitle(title: string): this;
     /**Set the custom id of this modal. */
@@ -858,6 +861,8 @@ export interface ODDropdownComponentData {
     maxValues?: number;
     /**Is this dropdown disabled? */
     disabled?: boolean;
+    /**Is this dropdown required? (MODAL ONLY) */
+    required?: boolean;
     /**Allowed channel types when the type is "channel" */
     channelTypes?: discord.ChannelType[];
     /**The options when the type is "string" */
@@ -890,6 +895,8 @@ export declare class ODDropdownComponent extends ODComponent<ODDropdownComponent
     setPlaceholder(placeholder: string | null): this;
     /**Disable this dropdown. */
     setDisabled(disabled: boolean): this;
+    /**Mark this dropdown as required in modals. */
+    setRequired(required: boolean): this;
     /**Set the available channel types of this dropdown. */
     setChannelTypes(channelTypes: discord.ChannelType[]): this;
     /**Set the options of this dropdown (when `type == "string"`) */

package/dist/api/modules/component.js

@@ -538,11 +538,14 @@ export class ODModalComponent extends ODGroupComponent {
                     components.push(res.toJSON());
             }
         }
-        return new discord.ModalBuilder({
-            components,
-            title: this.data.title,
-            customId: this.data.customId
-        });
+        return {
+            id: new ODId(this.id),
+            modal: new discord.ModalBuilder({
+                components,
+                title: this.data.title,
+                customId: this.data.customId
+            })
+        };
     }
     /**Set the title of the modal. */
     setTitle(title) {
@@ -1253,7 +1256,7 @@ export class ODDropdownComponent extends ODComponent {
             return new discord.StringSelectMenuBuilder({
                 ...genericOpts,
                 options: this.data.options
-            });
+            }).setRequired(this.data.required ?? false);
         }
         else if (this.data.type == "user") {
             if (!this.data.users || this.data.users.length < 1)
@@ -1261,7 +1264,7 @@ export class ODDropdownComponent extends ODComponent {
             return new discord.UserSelectMenuBuilder({
                 ...genericOpts,
                 defaultValues: this.data.users.map((u) => ({ id: u.id, type: discord.SelectMenuDefaultValueType.User }))
-            });
+            }).setRequired(this.data.required ?? false);
         }
         else if (this.data.type == "role") {
             if (!this.data.roles || this.data.roles.length < 1)
@@ -1269,7 +1272,7 @@ export class ODDropdownComponent extends ODComponent {
             return new discord.RoleSelectMenuBuilder({
                 ...genericOpts,
                 defaultValues: this.data.roles.map((r) => ({ id: r.id, type: discord.SelectMenuDefaultValueType.Role }))
-            });
+            }).setRequired(this.data.required ?? false);
         }
         else if (this.data.type == "channel") {
             if (!this.data.channels || this.data.channels.length < 1)
@@ -1278,7 +1281,7 @@ export class ODDropdownComponent extends ODComponent {
                 ...genericOpts,
                 channelTypes: this.data.channelTypes,
                 defaultValues: this.data.channels.map((c) => ({ id: c.id, type: discord.SelectMenuDefaultValueType.Channel }))
-            });
+            }).setRequired(this.data.required ?? false);
         }
         else if (this.data.type == "mentionable") {
             if (!this.data.mentionables || this.data.mentionables.length < 1)
@@ -1286,7 +1289,7 @@ export class ODDropdownComponent extends ODComponent {
             return new discord.MentionableSelectMenuBuilder({
                 ...genericOpts,
                 defaultValues: this.data.mentionables.map((m) => (m instanceof discord.User ? { id: m.id, type: discord.SelectMenuDefaultValueType.User } : { id: m.id, type: discord.SelectMenuDefaultValueType.Role }))
-            });
+            }).setRequired(this.data.required ?? false);
         }
         else
             throw new ODSystemError("ODDropdownComponent:build('" + this.id.value + "') => Please set the dropdown type to one of the following: string, user, role, channel, mentionable.");
@@ -1321,6 +1324,11 @@ export class ODDropdownComponent extends ODComponent {
         this.data.disabled = disabled;
         return this;
     }
+    /**Mark this dropdown as required in modals. */
+    setRequired(required) {
+        this.data.required = required;
+        return this;
+    }
     /**Set the available channel types of this dropdown. */
     setChannelTypes(channelTypes) {
         this.data.channelTypes = channelTypes;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.4.6",
+    "version": "0.4.8",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",