Full V13 support: Interactions (buttons and select menus) and reactions!

.gitignore

@@ -59,3 +59,6 @@ typings/
 
 # next.js build output
 .next
+
+# vscode
+.vscode/

index.d.ts

@@ -0,0 +1,14 @@
+import { EmojiIdentifierResolvable, Message, MessageEmbed, MessageReaction, ReactionCollectorOptions, User } from "discord.js";
+
+interface PaginationOptions extends ReactionCollectorOptions {
+  deleteOnEnd?: boolean,
+  useUtil?: boolean,
+  emojiList?: EmojiIdentifierResolvable[],
+  collectorFilter?(reaction: MessageReaction, user: User): boolean | Promise<boolean>
+  footerResolver?(pageIndex: number, pagesLength: number): string,
+  pageResolver?(msg: Message, pages: MessageEmbed[], emojiList: string[], currentPageIndex: number, reaction: MessageReaction): number | Promise<number>
+}
+
+declare function paginationEmbed (msg: Message, pages: MessageEmbed[], paginationOptions?: PaginationOptions): Promise<Message>
+
+export = paginationEmbed;

index.js

@@ -1,33 +1,81 @@
-const paginationEmbed = async (msg, pages, emojiList = ['⏪', '⏩'], timeout = 120000) => {
+/**
+ *
+ * @param {MessageEmbed[]} pages
+ * @param {EmojiIdentifierResolvable[]} emojiList
+ * @param {number} currentPageIndex
+ * @param {MessageReaction} reaction
+ * @returns {number} - the new page index.
+ */
+const defaultPageResolver = async (_, pages, emojiList, currentPageIndex, reaction) => {
+	let newPage = currentPageIndex;
+	switch (reaction.emoji.name) {
+		case emojiList[0]:
+			newPage = currentPageIndex > 0 ? currentPageIndex - 1 : pages.length - 1;
+			break;
+		case emojiList[1]:
+			newPage = currentPageIndex + 1 < pages.length ? currentPageIndex + 1 : 0;
+			break;
+		default:
+			return currentPageIndex;
+	}
+	return newPage;
+};
+
+const defaultFooterResolver = (currentPageIndex, pagesLength) =>`Page ${currentPageIndex + 1} / ${pagesLength}`;
+
+/**
+ *
+ * @param {Message} msg - the message
+ * @param {MessageEmbed[]} pages - array of message embeds to use as each page.
+ * @param {PaginationOptions} paginationOptions - exposes collector options, provides customization.
+ */
+const paginationEmbed = async (
+										msg, pages,
+										{
+											deleteOnEnd = false, useUtil = false,
+											emojiList = ['⏪', '⏩'],
+											collectorFilter = null,
+											footerResolver = defaultFooterResolver,
+											pageResolver = defaultPageResolver,
+											timeout = 120000,
+											...rest
+										} = {}) => {
 	if (!msg && !msg.channel) throw new Error('Channel is inaccessible.');
 	if (!pages) throw new Error('Pages are not given.');
-	if (emojiList.length !== 2) throw new Error('Need two emojis.');
 	let page = 0;
-	const curPage = await msg.channel.send(pages[page].setFooter(`Page ${page + 1} / ${pages.length}`));
-	for (const emoji of emojiList) await curPage.react(emoji);
+	pages[page].setFooter(footerResolver(page, pages.length));
+	const curPage = useUtil ? await msg.util.reply(pages[page]) : await msg.channel.send(pages[page]);
 	const reactionCollector = curPage.createReactionCollector(
-		(reaction, user) => emojiList.includes(reaction.emoji.name) && !user.bot,
-		{ time: timeout }
+		(reaction, user) => emojiList.includes(reaction.emoji.name) && !user.bot
+							&& (collectorFilter ? collectorFilter(reaction, user, emojiList) : true),
+		{ time: timeout, ...rest }
 	);
-	reactionCollector.on('collect', reaction => {
-		reaction.users.remove(msg.author);
-		switch (reaction.emoji.name) {
-			case emojiList[0]:
-				page = page > 0 ? --page : pages.length - 1;
-				break;
-			case emojiList[1]:
-				page = page + 1 < pages.length ? ++page : 0;
-				break;
-			default:
-				break;
-		}
-		curPage.edit(pages[page].setFooter(`Page ${page + 1} / ${pages.length}`));
+	reactionCollector.on('collect', async (reaction, user) => {
+		// In case a react deletes the curPage msg in the pageResolver and another react is quickly made.
+		if (curPage.deleted) return;
+		await reaction.users.remove(user.id);
+		const currentPage = page;
+		page = await pageResolver(curPage, pages, emojiList, page, reaction);
+
+		if ( !curPage.deleted && currentPage != page && page >= 0 && page < pages.length)
+			curPage.edit(pages[page].setFooter(footerResolver(page, pages.length)));
 	});
-	reactionCollector.on('end', () => {
+	reactionCollector.on('end', async () => {
 		if (!curPage.deleted) {
-			curPage.reactions.removeAll()
+			if (deleteOnEnd)
+				await curPage.delete();
+			else
+				curPage.reactions.removeAll();
 		}
 	});
+	// This will fail if the message is deleted before the reactions are all added, bail before reactor creation
+	try {
+		for (const emoji of emojiList) await curPage.react(emoji);
+	} catch (error) {
+			reactionCollector.stop();
+			throw error;
+	}
 	return curPage;
 };
+
 module.exports = paginationEmbed;

package.json

@@ -3,6 +3,7 @@
   "version": "1.0.3",
   "description": "A simple utility to paginate discord embeds. ",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },