@open-discord-bots/framework 0.3.0 → 0.3.1

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

@@ -3,7 +3,8 @@ import * as discord from "discord.js";
 import { ODWorkerManager, ODWorkerCallback } from "./worker.js";
 import { ODDebugger } from "./console.js";
 import { ODClientManager, ODContextMenu, ODSlashCommand, ODTextCommand, ODTextCommandInteractionOption } from "./client.js";
-import { ODDropdownData, ODMessageBuildResult, ODMessageBuildSentResult, ODModalBuildResult } from "./builder.js";
+import { ODDropdownData, ODMessageBuildResult, ODModalBuildResult } from "./builder.js";
+import { ODMessageComponentBuildResult } from "./component.js";
 /**## ODResponderImplementation `class`
  * This is an Open Discord responder implementation.
  *
@@ -23,7 +24,21 @@ export declare abstract class ODResponderImplementation<Instance, Origin extends
 /**## ODResponderTimeoutErrorCallback `type`
  * This is the callback for the responder timeout function. It will be executed when something went wrong or the action takes too much time.
  */
-export type ODResponderTimeoutErrorCallback<Instance, Origin extends "slash" | "text" | "button" | "dropdown" | "modal" | "other" | "context-menu" | "autocomplete"> = (instance: Instance, origin: Origin) => void | Promise<void>;
+export type ODResponderTimeoutErrorCallback<Instance, Origin extends "slash" | "text" | "button" | "dropdown" | "modal" | "other" | "context-menu" | "autocomplete"> = (instance: Instance, origin: Origin) => ODResponderSendResult<boolean> | Promise<ODResponderSendResult<boolean>>;
+/**## ODResponderSendResult `type`
+ * The result from a sent message using responders. Can be used to edit, view & save the message that got created.
+ */
+export type ODResponderSendResult<InGuild extends boolean> = {
+    /**Did the message get sent successfully? */
+    success: true;
+    /**The message that got sent. */
+    message: discord.Message<InGuild>;
+} | {
+    /**Did the message get sent successfully? */
+    success: boolean;
+    /**The message that got sent. */
+    message: null;
+};
 /**## ODResponderManager `class`
  * This is an Open Discord responder manager.
  *
@@ -53,6 +68,15 @@ export declare class ODResponderManager<CommandIdList extends ODCommandResponder
     autocomplete: ODAutocompleteResponderManager<AutocompleteIdList>;
     constructor(debug: ODDebugger, client: ODClientManager);
 }
+/**## ODBaseResponderInstance `class`
+ * A base class for creating responder instances.
+ */
+export declare abstract class ODBaseResponderInstance {
+    /**Get the final `messageCreateOptions` from a returned build result from builders/components. */
+    protected getMessageFromBuildResult(build: ODMessageBuildResult | ODMessageComponentBuildResult, type: "interaction" | "message"): discord.MessageCreateOptions & {
+        flags: number[];
+    };
+}
 /**## ODCommandResponderManagerIdConstraint `type`
  * The constraint/layout for id mappings/interfaces of the `ODCommandResponderManager` class.
  */
@@ -76,7 +100,12 @@ export type ODCommandResponderManagerIdConstraint = Record<string, {
  * - And so much more!
  */
 export declare class ODCommandResponderManager<IdList extends ODCommandResponderManagerIdConstraint = ODCommandResponderManagerIdConstraint> extends ODManager<ODCommandResponder<"slash" | "text", any>> {
-    #private;
+    /**An alias to the Open Discord client manager. */
+    private client;
+    /**The callback executed when the default workers take too much time to reply. */
+    private timeoutErrorCallback;
+    /**The amount of milliseconds before the timeout error callback is executed. */
+    private timeoutMs;
     constructor(debug: ODDebugger, debugname: string, client: ODClientManager);
     /**Set the message to send when the response times out! */
     setTimeoutErrorCallback(callback: ODResponderTimeoutErrorCallback<ODCommandResponderInstance, "slash" | "text"> | null, ms: number | null): void;
@@ -94,7 +123,12 @@ export declare class ODCommandResponderManager<IdList extends ODCommandResponder
  * This class will manage all options & subcommands from slash & text commands.
  */
 export declare class ODCommandResponderInstanceOptions {
-    #private;
+    /**The interaction to get data from. */
+    private interaction;
+    /**The command which is related to the interaction. */
+    private cmd;
+    /**A list of options which have been parsed by the text command parser. */
+    private options;
     constructor(interaction: discord.ChatInputCommandInteraction | discord.Message, cmd: ODSlashCommand | ODTextCommand, options?: ODTextCommandInteractionOption[]);
     /**Get a string option. */
     getString(name: string, required: true): string;
@@ -130,7 +164,7 @@ export declare class ODCommandResponderInstanceOptions {
  *
  * An instance is an active slash interaction or used text command. You can reply to the command using `reply()` for both slash & text commands.
  */
-export declare class ODCommandResponderInstance {
+export declare class ODCommandResponderInstance extends ODBaseResponderInstance {
     /**The interaction which is the source of this instance. */
     interaction: discord.ChatInputCommandInteraction | discord.Message;
     /**The command wich is the source of this instance. */
@@ -151,7 +185,7 @@ export declare class ODCommandResponderInstance {
     channel: discord.TextBasedChannel;
     constructor(interaction: discord.ChatInputCommandInteraction | discord.Message, cmd: ODSlashCommand | ODTextCommand, errorCallback: ODResponderTimeoutErrorCallback<ODCommandResponderInstance, "slash" | "text"> | null, timeoutMs: number | null, options?: ODTextCommandInteractionOption[]);
     /**Reply to this command. */
-    reply(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<boolean>>;
+    reply(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<boolean>>;
     /**Defer this command. */
     defer(ephemeral: boolean): Promise<boolean>;
     /**Show a modal as reply to this command. */
@@ -191,7 +225,14 @@ export type ODButtonResponderManagerIdConstraint = Record<string, {
  * - And so much more!
  */
 export declare class ODButtonResponderManager<IdList extends ODButtonResponderManagerIdConstraint = ODButtonResponderManagerIdConstraint> extends ODManager<ODButtonResponder<"button", any>> {
-    #private;
+    /**An alias to the Open Discord client manager. */
+    private client;
+    /**The callback executed when the default workers take too much time to reply. */
+    private timeoutErrorCallback;
+    /**The amount of milliseconds before the timeout error callback is executed. */
+    private timeoutMs;
+    /**A list of listeners which will listen to the raw interactionCreate event from discord.js */
+    private listeners;
     constructor(debug: ODDebugger, debugname: string, client: ODClientManager);
     /**Set the message to send when the response times out! */
     setTimeoutErrorCallback(callback: ODResponderTimeoutErrorCallback<ODButtonResponderInstance, "button"> | null, ms: number | null): void;
@@ -208,7 +249,7 @@ export declare class ODButtonResponderManager<IdList extends ODButtonResponderMa
  *
  * An instance is an active button interaction. You can reply to the button using `reply()`.
  */
-export declare class ODButtonResponderInstance {
+export declare class ODButtonResponderInstance extends ODBaseResponderInstance {
     /**The interaction which is the source of this instance. */
     interaction: discord.ButtonInteraction;
     /**Did a worker already reply to this instance/interaction? */
@@ -225,9 +266,9 @@ export declare class ODButtonResponderInstance {
     message: discord.Message;
     constructor(interaction: discord.ButtonInteraction, errorCallback: ODResponderTimeoutErrorCallback<ODButtonResponderInstance, "button"> | null, timeoutMs: number | null);
     /**Reply to this button. */
-    reply(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<boolean>>;
+    reply(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<boolean>>;
     /**Update the message of this button. */
-    update(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<boolean>>;
+    update(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<boolean>>;
     /**Defer this button. */
     defer(type: "reply" | "update", ephemeral: boolean): Promise<boolean>;
     /**Show a modal as reply to this button. */
@@ -273,7 +314,14 @@ export type ODDropdownResponderManagerIdConstraint = Record<string, {
  * - And so much more!
  */
 export declare class ODDropdownResponderManager<IdList extends ODDropdownResponderManagerIdConstraint = ODDropdownResponderManagerIdConstraint> extends ODManager<ODDropdownResponder<"dropdown", any>> {
-    #private;
+    /**An alias to the Open Discord client manager. */
+    private client;
+    /**The callback executed when the default workers take too much time to reply. */
+    private timeoutErrorCallback;
+    /**The amount of milliseconds before the timeout error callback is executed. */
+    private timeoutMs;
+    /**A list of listeners which will listen to the raw interactionCreate event from discord.js */
+    private listeners;
     constructor(debug: ODDebugger, debugname: string, client: ODClientManager);
     /**Set the message to send when the response times out! */
     setTimeoutErrorCallback(callback: ODResponderTimeoutErrorCallback<ODDropdownResponderInstance, "dropdown"> | null, ms: number | null): void;
@@ -291,7 +339,10 @@ export declare class ODDropdownResponderManager<IdList extends ODDropdownRespond
  * This class will manage all values from the dropdowns & select menus.
  */
 export declare class ODDropdownResponderInstanceValues {
-    #private;
+    /**The interaction to get data from. */
+    private interaction;
+    /**The type of this dropdown. */
+    private type;
     constructor(interaction: discord.AnySelectMenuInteraction, type: ODDropdownData["type"]);
     /**Get the selected values. */
     getStringValues(): string[];
@@ -307,7 +358,7 @@ export declare class ODDropdownResponderInstanceValues {
  *
  * An instance is an active dropdown interaction. You can reply to the dropdown using `reply()`.
  */
-export declare class ODDropdownResponderInstance {
+export declare class ODDropdownResponderInstance extends ODBaseResponderInstance {
     /**The interaction which is the source of this instance. */
     interaction: discord.AnySelectMenuInteraction;
     /**Did a worker already reply to this instance/interaction? */
@@ -328,9 +379,9 @@ export declare class ODDropdownResponderInstance {
     message: discord.Message;
     constructor(interaction: discord.AnySelectMenuInteraction, errorCallback: ODResponderTimeoutErrorCallback<ODDropdownResponderInstance, "dropdown"> | null, timeoutMs: number | null);
     /**Reply to this dropdown. */
-    reply(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<boolean>>;
+    reply(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<boolean>>;
     /**Update the message of this dropdown. */
-    update(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<boolean>>;
+    update(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<boolean>>;
     /**Defer this dropdown. */
     defer(type: "reply" | "update", ephemeral: boolean): Promise<boolean>;
     /**Show a modal as reply to this dropdown. */
@@ -376,7 +427,14 @@ export type ODModalResponderManagerIdConstraint = Record<string, {
  * - And so much more!
  */
 export declare class ODModalResponderManager<IdList extends ODModalResponderManagerIdConstraint = ODModalResponderManagerIdConstraint> extends ODManager<ODModalResponder<"modal", any>> {
-    #private;
+    /**An alias to the Open Discord client manager. */
+    private client;
+    /**The callback executed when the default workers take too much time to reply. */
+    private timeoutErrorCallback;
+    /**The amount of milliseconds before the timeout error callback is executed. */
+    private timeoutMs;
+    /**A list of listeners which will listen to the raw interactionCreate event from discord.js */
+    private listeners;
     constructor(debug: ODDebugger, debugname: string, client: ODClientManager);
     /**Set the message to send when the response times out! */
     setTimeoutErrorCallback(callback: ODResponderTimeoutErrorCallback<ODModalResponderInstance, "modal"> | null, ms: number | null): void;
@@ -394,7 +452,8 @@ export declare class ODModalResponderManager<IdList extends ODModalResponderMana
  * This class will manage all fields from the modals.
  */
 export declare class ODModalResponderInstanceValues {
-    #private;
+    /**The interaction to get data from. */
+    private interaction;
     constructor(interaction: discord.ModalSubmitInteraction);
     /**Get the value of a text field. */
     getTextField(name: string, required: true): string;
@@ -405,7 +464,7 @@ export declare class ODModalResponderInstanceValues {
  *
  * An instance is an active modal interaction. You can reply to the modal using `reply()`.
  */
-export declare class ODModalResponderInstance {
+export declare class ODModalResponderInstance extends ODBaseResponderInstance {
     /**The interaction which is the source of this instance. */
     interaction: discord.ModalSubmitInteraction;
     /**Did a worker already reply to this instance/interaction? */
@@ -422,9 +481,9 @@ export declare class ODModalResponderInstance {
     channel: discord.TextBasedChannel | null;
     constructor(interaction: discord.ModalSubmitInteraction, errorCallback: ODResponderTimeoutErrorCallback<ODModalResponderInstance, "modal"> | null, timeoutMs: number | null);
     /**Reply to this modal. */
-    reply(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<boolean>>;
+    reply(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<boolean>>;
     /**Update the message of this modal. */
-    update(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<boolean>>;
+    update(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<boolean>>;
     /**Defer this modal. */
     defer(type: "reply" | "update", ephemeral: boolean): Promise<boolean>;
 }
@@ -459,7 +518,12 @@ export type ODContextMenuResponderManagerIdConstraint = Record<string, {
  * - And so much more!
  */
 export declare class ODContextMenuResponderManager<IdList extends ODContextMenuResponderManagerIdConstraint = ODContextMenuResponderManagerIdConstraint> extends ODManager<ODContextMenuResponder<"context-menu", any>> {
-    #private;
+    /**An alias to the Open Discord client manager. */
+    private client;
+    /**The callback executed when the default workers take too much time to reply. */
+    private timeoutErrorCallback;
+    /**The amount of milliseconds before the timeout error callback is executed. */
+    private timeoutMs;
     constructor(debug: ODDebugger, debugname: string, client: ODClientManager);
     /**Set the message to send when the response times out! */
     setTimeoutErrorCallback(callback: ODResponderTimeoutErrorCallback<ODContextMenuResponderInstance, "context-menu"> | null, ms: number | null): void;
@@ -476,7 +540,7 @@ export declare class ODContextMenuResponderManager<IdList extends ODContextMenuR
  *
  * An instance is an active context menu interaction. You can reply to the context menu using `reply()`.
  */
-export declare class ODContextMenuResponderInstance {
+export declare class ODContextMenuResponderInstance extends ODBaseResponderInstance {
     /**The interaction which is the source of this instance. */
     interaction: discord.ContextMenuCommandInteraction;
     /**Did a worker already reply to this instance/interaction? */
@@ -495,9 +559,9 @@ export declare class ODContextMenuResponderInstance {
     target: discord.Message | discord.User;
     constructor(interaction: discord.ContextMenuCommandInteraction, menu: ODContextMenu, errorCallback: ODResponderTimeoutErrorCallback<ODContextMenuResponderInstance, "context-menu"> | null, timeoutMs: number | null);
     /**Reply to this context menu. */
-    reply(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<boolean>>;
+    reply(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<boolean>>;
     /**Update the message of this context menu. */
-    update(msg: ODMessageBuildResult): Promise<ODMessageBuildSentResult<boolean>>;
+    update(build: ODMessageBuildResult | ODMessageComponentBuildResult): Promise<ODResponderSendResult<boolean>>;
     /**Defer this context menu. */
     defer(type: "reply", ephemeral: boolean): Promise<boolean>;
     /**Show a modal as reply to this context menu. */
@@ -534,7 +598,12 @@ export type ODAutocompleteResponderManagerIdConstraint = Record<string, {
  * - And so much more!
  */
 export declare class ODAutocompleteResponderManager<IdList extends ODAutocompleteResponderManagerIdConstraint = ODAutocompleteResponderManagerIdConstraint> extends ODManager<ODAutocompleteResponder<"autocomplete", any>> {
-    #private;
+    /**An alias to the Open Discord client manager. */
+    private client;
+    /**The callback executed when the default workers take too much time to reply. */
+    private timeoutErrorCallback;
+    /**The amount of milliseconds before the timeout error callback is executed. */
+    private timeoutMs;
     constructor(debug: ODDebugger, debugname: string, client: ODClientManager);
     /**Set the message to send when the response times out! */
     setTimeoutErrorCallback(callback: ODResponderTimeoutErrorCallback<ODAutocompleteResponderInstance, "autocomplete"> | null, ms: number | null): void;
@@ -551,7 +620,7 @@ export declare class ODAutocompleteResponderManager<IdList extends ODAutocomplet
  *
  * An instance is an active autocomplete interaction. You can reply to the autocomplete using `reply()`.
  */
-export declare class ODAutocompleteResponderInstance {
+export declare class ODAutocompleteResponderInstance extends ODBaseResponderInstance {
     /**The interaction which is the source of this instance. */
     interaction: discord.AutocompleteInteraction;
     /**Did a worker already respond to this instance/interaction? */