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

.gitignore

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

README.md

@@ -13,6 +13,7 @@ A simple utility to paginate discord embeds. Built on discord.js@^12.0.0 (master
 * `npm install discord.js-pagination`
 
 # Usage
+
 __Basic Bot Example__
 ```js
 // Import the discord.js-pagination package
@@ -21,20 +22,26 @@ const paginationEmbed = require('discord.js-pagination');
 // Use either MessageEmbed or RichEmbed to make pages
 // Keep in mind that Embeds should't have their footers set since the pagination method sets page info there
 const { MessageEmbed } = require('discord.js');
-const embed1 = new MessageEmbed();
 
-// Create an array of embeds
-pages = [
-	embed1,
-	embed2,
-	//....
-	embedn
-];
+const myPages = [];
+
+for (let i = 0; i < 10; i++) {
+	const pageEmbed = new MessageEmbed();
+	pageEmbed
+		.setTitle(`This embed is index ${i}!`)
+		.setDescription(`That means it is page #${i+1}`);
+	myPages.push(pageEmbed);
+}
+
+const footerResolver = (currentPageIndex, pagesLength) =>
+	`Page ${currentPageIndex + 1} / ${pagesLength}: ${(currentPageIndex % 2 === 0) ? 'This page is even!' : 'This page is odd!'}`;
+
+const collectErrorHandler = ({ error }) => console.log(error);
 
 // Call the paginationEmbed method, first two arguments are required
-// emojiList is the pageturners defaults to ['⏪', '⏩']
-// timeout is the time till the reaction collectors are active, after this you can't change pages (in ms), defaults to 120000
-paginationEmbed(msg, pages, emojiList, timeout);
+// The third argument is the PaginationOptions - all optional
+// Any additional arguments in PaginationOptions are passed down as ReactionCollectorOptions
+paginationEmbed(msg, myPages, { emojiList, footerResolver, collectErrorHandler, timeout: 120000, idle: 60000 });
 // There you go, now you have paged embeds
 ```
 # Preview

index.d.ts

@@ -0,0 +1,44 @@
+import { EmojiIdentifierResolvable, Message, MessageEmbed, MessageReaction, ReactionCollector, ReactionCollectorOptions, User } from "discord.js";
+
+interface PageResolverParameters {
+  paginatedEmbedMessage?: MessageEmbed;
+  pages?: MessageEmbed[];
+  emojiList?: string[];
+  currentPageIndex?: number;
+  reaction?: MessageReaction;
+}
+
+interface CollectorFilterParameters {
+  reaction?: MessageReaction;
+  user?: User;
+  emojiList: string[];
+}
+
+interface BaseHandlerParameters {
+  receivedMessage?: Message;
+  paginatedEmbedMessage?: MessageEmbed;
+}
+
+interface CollectErrorHandlerParameters extends BaseHandlerParameters {
+  error?: Error;
+  reactionCollector?: ReactionCollector;
+}
+
+interface CollectEndHandlerParameters extends BaseHandlerParameters {
+  collected?: Collection<Snowflake, MessageReaction>;
+  reason?: string;
+}
+
+interface PaginationOptions extends ReactionCollectorOptions {
+  emojiList?: EmojiIdentifierResolvable[];
+  footerResolver?(pageIndex: number, pagesLength: number): string;
+  sendMessage?(receivedMessage: Message, pageEmbed: MessageEmbed): Promise<Message>;
+  collectorFilter?(collectorFilterParameters?: CollectorFilterParameters): boolean | Promise<boolean>;
+  pageResolver?(pageResolverParameters?: PageResolverParameters): number | Promise<number>;
+  collectErrorHandler?(collectErrorHandlerParameters?: CollectErrorHandlerParameters): void | Promise<void>;
+  collectorEndHandler?(collectorEndHandlerParameters?: CollectEndHandlerParameters): void | Promise<void>;
+}
+
+declare function paginationEmbed(receivedMessage: Message, pages: MessageEmbed[], paginationOptions?: PaginationOptions): Promise<Message>;
+
+export = paginationEmbed;

index.js

@@ -1,33 +1,87 @@
-const paginationEmbed = async (msg, pages, emojiList = ['⏪', '⏩'], timeout = 120000) => {
-	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);
-	const reactionCollector = curPage.createReactionCollector(
-		(reaction, user) => emojiList.includes(reaction.emoji.name) && !user.bot,
-		{ time: timeout }
-	);
-	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('end', () => {
-		if (!curPage.deleted) {
-			curPage.reactions.removeAll()
-		}
-	});
-	return curPage;
+/**
+ *
+ * @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}`;
+
+const defaultSendMessage = (message, pageEmbed) => message.channel.send(pageEmbed);
+
+const defaultCollectorFilter = ({ reaction, user, emojiList }) => emojiList.includes(reaction.emoji.name) && !user.bot;
+
+const defaultCollectorEndHandler = ({ paginatedEmbedMessage }) => {
+  if (!paginatedEmbedMessage.deleted)
+    await paginatedEmbedMessage.reactions.removeAll();
+}
+
+/**
+ *
+ * @param {Message} receivedMessage - the received message
+ * @param {MessageEmbed[]} pages - array of message embeds to use as each page.
+ * @param {PaginationOptions} paginationOptions - exposes collector options, provides customization.
+ */
+const paginationEmbed = async (receivedMessage, pages,
+  {
+    emojiList = ['⏪', '⏩'],
+    footerResolver = defaultFooterResolver,
+    sendMessage = defaultSendMessage,
+    collectorFilter = defaultCollectorFilter,
+    pageResolver = defaultPageResolver,
+    collectErrorHandler = () => {},
+    collectorEndHandler = defaultCollectorEndHandler,
+    timeout = 120000,
+    ...rest
+  } = {}
+) => {
+  if (!receivedMessage && !receivedMessage.channel) throw new Error('Channel is inaccessible.');
+  if (!pages) throw new Error('Pages are not given.');
+  let currentPageIndex = 0;
+  pages[currentPageIndex].setFooter(footerResolver(currentPageIndex, pages.length));
+  const paginatedEmbedMessage = await sendMessage(receivedMessage, pages[currentPageIndex]);
+  const reactionCollector = paginatedEmbedMessage.createReactionCollector(
+    async (reaction, user) => {
+        await collectorFilter(reaction, user, emojiList)
+      },
+      { time: timeout, ...rest }
+  );
+  reactionCollector.on('collect', async (reaction, user) => {
+    // this try / catch is to handle the edge case where a collect event is fired after a message delete call
+    // but before the delete is complete, handling is offloaded to the user via collectErrorHandler
+    try {
+      await reaction.users.remove(user.id);
+      const currentPage = currentPageIndex;
+
+      currentPageIndex = await pageResolver({ paginatedEmbedMessage, pages, emojiList, currentPageIndex, reaction });
+      if ( !paginatedEmbedMessage.deleted && currentPage != currentPageIndex && currentPageIndex >= 0 && currentPageIndex < pages.length)
+        await paginatedEmbedMessage.edit(pages[currentPageIndex].setFooter(footerResolver(currentPageIndex, pages.length)));
+    } catch(error) {
+      await collectErrorHandler({ error, receivedMessage, paginatedEmbedMessage });
+    }
+  });
+  reactionCollector.on('end', async (collected, reason) => {
+    await collectorEndHandler({ collected, reason, paginatedEmbedMessage, receivedMessage });
+  });
+  for (const emoji of emojiList)
+    await paginatedEmbedMessage.react(emoji);
+  return paginatedEmbedMessage;
+};
+
 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"
   },