@moody-djs/prompts 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,112 @@
+import { RepliableInteraction, EmbedBuilder, ButtonInteraction, ButtonBuilder, StringSelectMenuInteraction, StringSelectMenuBuilder, ModalSubmitInteraction, ModalBuilder } from 'discord.js';
+
+type MaybePromise<T> = T | Promise<T>;
+
+/** An enum containing the prompt component types that are supported */
+declare enum PromptComponentType {
+    Button = 0,
+    ModalButton = 1,
+    SelectMenu = 2,
+    ModalSelectMenu = 3
+}
+type PromptContext<Context extends object, T = RepliableInteraction> = Context & {
+    interaction?: T;
+    previousStates: string[];
+    goBack: () => string;
+    genericError?: string;
+};
+interface ModalComponentReturnType<T, Interaction> {
+    button: T;
+    modal: ModalBuilder | ((interaction: Interaction) => MaybePromise<ModalBuilder | null>);
+}
+interface PromptStateComponentBase<Context extends object, Interaction = RepliableInteraction> {
+    callback: string | ((ctx: PromptContext<Context, Interaction>) => MaybePromise<string | undefined>);
+}
+interface PromptStateComponentBaseWithInteraction<Context extends object, Interaction = RepliableInteraction, AlternateInteraction = Interaction> {
+    callback: string | ((ctx: PromptContext<Context, Interaction>, interaction: AlternateInteraction) => MaybePromise<string | undefined>);
+}
+/** A prompt state that uses a button component */
+interface PromptStateButtonComponent<T extends object> extends PromptStateComponentBase<T, ButtonInteraction> {
+    type: PromptComponentType.Button;
+    component: ButtonBuilder | ((ctx: PromptContext<T>) => MaybePromise<ButtonBuilder>);
+}
+/** A prompt state that contains a select menu */
+interface PromptStateSelectMenuComponent<T extends object> extends PromptStateComponentBase<T, StringSelectMenuInteraction> {
+    type: PromptComponentType.SelectMenu;
+    component: StringSelectMenuBuilder | ((ctx: PromptContext<T>) => MaybePromise<StringSelectMenuBuilder>);
+}
+/** A prompt state that uses a modal that is opened by a button */
+interface PromptStateModalButtonComponent<T extends object> extends PromptStateComponentBaseWithInteraction<T, ButtonInteraction, ModalSubmitInteraction> {
+    type: PromptComponentType.ModalButton;
+    component: ModalComponentReturnType<ButtonBuilder, ButtonInteraction> | ((ctx: PromptContext<T>) => MaybePromise<ModalComponentReturnType<ButtonBuilder, ButtonInteraction>>);
+}
+/** A prompt state that is a modal opened by a select menu component */
+interface PromptStateModalSelectMenuComponent<T extends object> extends PromptStateComponentBaseWithInteraction<T, StringSelectMenuInteraction, ModalSubmitInteraction | null> {
+    type: PromptComponentType.ModalSelectMenu;
+    component: ModalComponentReturnType<StringSelectMenuBuilder, StringSelectMenuInteraction> | ((ctx: PromptContext<T>) => MaybePromise<ModalComponentReturnType<StringSelectMenuBuilder, StringSelectMenuInteraction>>);
+}
+/** A type representing a prompt state component, used when defining the components added for a prompt state */
+type PromptStateComponent<T extends object> = PromptStateButtonComponent<T> | PromptStateSelectMenuComponent<T> | PromptStateModalSelectMenuComponent<T> | PromptStateModalButtonComponent<T>;
+/** A prompt state message callback */
+interface PromptStateMessageCallback<T extends object> {
+    ephemeral: boolean;
+    content?: string | ((ctx: PromptContext<T>) => MaybePromise<string | undefined>);
+    embeds: EmbedBuilder[] | ((ctx: PromptContext<T>) => MaybePromise<EmbedBuilder[]>);
+    components: PromptStateComponent<T>[][] | ((ctx: PromptContext<T>) => MaybePromise<PromptStateComponent<T>[][]>);
+}
+/**
+ * A type representing a prompt state that is possible
+ * @param T The type of the prompt context
+ */
+interface PromptState<T extends object> {
+    name: string;
+    timeout?: number;
+    onEntered?: (ctx: PromptContext<T>) => MaybePromise<string | undefined>;
+    message: PromptStateMessageCallback<T> | ((ctx: PromptContext<T>) => MaybePromise<PromptStateMessageCallback<T>>);
+}
+
+/**
+ * A prompt that allows you to create a sequence of states that a user can go through
+ * with discord.js buttons and select menus.
+ *
+ * @example
+ * ```ts
+ * const prompt = new Prompt<ContextType>(defaults, initialState.name, [...]);
+ * await prompt.start(interaction);
+ * ```
+ */
+declare class Prompt<T extends object> {
+    initialState: string;
+    /** The current context of this prompt */
+    private context;
+    /** The current state */
+    private currentState?;
+    /** All components for this prompt */
+    private components;
+    /** The interaction collector */
+    private collector?;
+    /** The states represented in a map */
+    states: Map<string, PromptState<T>>;
+    /** Creates the prompt with a given set of states */
+    constructor(defaults: T, initialState: string, states: PromptState<T>[]);
+    /**
+     * Starts the prompt with a given interaction
+     * @param interaction The interaction starting off the sequence
+     * @returns {boolean} If true, the prompt started successfully
+     */
+    start(interaction: RepliableInteraction): Promise<boolean>;
+    private changeState;
+    private handleCollect;
+    private prepareMessageOptions;
+    private getNewStateFromCallback;
+    private formatComponents;
+}
+
+declare class PromptError extends Error {
+    constructor(message: string);
+}
+declare class UserError extends Error {
+    constructor(message: string);
+}
+
+export { Prompt, PromptComponentType, type PromptContext, PromptError, type PromptState, type PromptStateButtonComponent, type PromptStateComponent, type PromptStateComponentBase, type PromptStateComponentBaseWithInteraction, type PromptStateMessageCallback, type PromptStateModalButtonComponent, type PromptStateModalSelectMenuComponent, type PromptStateSelectMenuComponent, UserError };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var d=Object.defineProperty;var M=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var h=Object.prototype.hasOwnProperty;var p=(r,t)=>d(r,"name",{value:t,configurable:!0});var C=(r,t)=>{for(var e in t)d(r,e,{get:t[e],enumerable:!0})},y=(r,t,e,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of b(t))!h.call(r,o)&&o!==e&&d(r,o,{get:()=>t[o],enumerable:!(n=M(t,o))||n.enumerable});return r};var f=r=>y(d({},"__esModule",{value:!0}),r);var P={};C(P,{Prompt:()=>g,PromptComponentType:()=>S,PromptError:()=>m,UserError:()=>x});module.exports=f(P);var c=require("discord.js");var S=(o=>(o[o.Button=0]="Button",o[o.ModalButton=1]="ModalButton",o[o.SelectMenu=2]="SelectMenu",o[o.ModalSelectMenu=3]="ModalSelectMenu",o))(S||{});var m=class r extends Error{static{p(this,"PromptError")}constructor(t){super(t),Error.captureStackTrace?.(this,r)}},x=class r extends Error{static{p(this,"UserError")}constructor(t){super(t),Error.captureStackTrace?.(this,r)}};var g=class{constructor(t,e,n){this.initialState=e;let o=[],a=p(()=>this.context.previousStates.pop()??this.initialState,"goBack");this.context={...t,previousStates:o,goBack:a},this.states=new Map(n.map(i=>[i.name,i]))}static{p(this,"Prompt")}context;currentState;components=new c.Collection;collector;states;async start(t){return this.context.interaction=t,this.changeState(this.initialState,t)}async changeState(t,e){let n=this.states.get(t);if(!n)return Promise.reject(new m(`State ${t} not found.`));this.context.previousStates.push(this.currentState?.name??this.initialState),this.currentState=n;let o=await n.onEntered?.(this.context);if(o)return this.changeState(o,e);let a=await this.prepareMessageOptions(n),i=e.replied||e.deferred?await e.editReply({embeds:a.embeds,components:a.components,content:a.content}):await e.reply(a);return this.collector&&this.collector.stop(),this.collector=i.createMessageComponentCollector({time:n.timeout||12e4,filter:p(s=>s.user.id===e.user.id,"filter")}),this.collector.on("collect",this.handleCollect.bind(this)),!0}async handleCollect(t){let e=this.components.get(t.customId);if(!e)throw new m(`Couldn't find component with customId: ${t.customId}`);if(e.type===1||e.type===3){let o=typeof e.component=="function"?await e.component(this.context):e.component,a=typeof o.modal=="function"?await o.modal(t):o.modal;if(!a){await t.deferUpdate(),this.collector?.stop(),this.context.interaction=t;let u=await this.getNewStateFromCallback(e)??this.currentState?.name;return u?void this.changeState(u,t):t.deleteReply()}let i=c.SnowflakeUtil.generate().toString();a.setCustomId(i),await t.showModal(a);let s=await t.awaitModalSubmit({time:3e5,filter:p(u=>u.user.id===t.user.id&&u.customId===i,"filter")}).catch(()=>null);if(!s)return;await s.deferUpdate(),this.collector?.stop(),this.context.interaction=s;let l=await this.getNewStateFromCallback(e,s)??this.currentState?.name;return l?void this.changeState(l,t):t.deleteReply()}await t.deferUpdate(),this.collector?.stop(),this.context.interaction=t;let n=await this.getNewStateFromCallback(e)??this.currentState?.name;if(!n)return t.deleteReply();this.changeState(n,t)}async prepareMessageOptions(t){let e=typeof t.message=="object"?t.message:await t.message(this.context);return{components:await this.formatComponents(e),fetchReply:!0,flags:e.ephemeral?c.MessageFlags.Ephemeral:0,content:typeof e.content=="function"?await e.content?.(this.context):e.content,embeds:Array.isArray(e.embeds)?e.embeds:await e.embeds(this.context)}}async getNewStateFromCallback(t,e){if(typeof t.callback=="string")return t.callback;if(t.type===1||t.type===3){if(!e)throw new m("No modal submit interaction found when required.");return t.callback(this.context,e)}return t.callback(this.context)}async formatComponents(t){let e=[],n=Array.isArray(t.components)?t.components:await t.components(this.context);this.components.clear();for(let o of n){let a=new c.ActionRowBuilder;for(let i of o){let s=typeof i.component=="function"?await i.component(this.context):i.component,l=c.SnowflakeUtil.generate().toString();"button"in s?(s.button.setCustomId(l),this.components.set(l,i),a.addComponents(s.button)):(s.setCustomId(l),this.components.set(l,i),a.addComponents(s))}e.push(a)}return e}};0&&(module.exports={Prompt,PromptComponentType,PromptError,UserError});

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@moody-djs/prompts",
+  "description": "A simple library for creating state based prompts in discord.js",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "files": [
+    "dist/**/*",
+    "package.json"
+  ],
+  "peerDependencies": {
+    "discord.js": "latest"
+  },
+  "keywords": [
+    "prompts",
+    "discord.js"
+  ],
+  "author": "ahmood",
+  "license": "ISC",
+  "scripts": {
+    "test": "tsc --noEmit --skipLibCheck",
+    "format": "biome format src --write",
+    "lint": "biome lint src --write",
+    "biome": "biome check src --write",
+    "build": "tsup",
+    "bump": "cliff-jumper",
+    "check-update": "cliff-jumper --dry-run"
+  }
+}