feat: allow both rest and array parameter

Breaking Change: Removed singular methods. Breaking Change: ExtraRowPosition is an enum now. More infos in discordjs/discord.js#7522 and discordjs/discord.js#7874
imranbarbhuiya · Jun 24, 2022 · 9c4d7a2 · 9c4d7a2
1 parent 10c9f43
commit 9c4d7a2
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 68 deletions.
diff --git a/src/lib/pagination/PaginationEmbed.ts b/src/lib/pagination/PaginationEmbed.ts
@@ -8,9 +8,11 @@ import {
 	EmbedBuilder,
 	MessageActionRowComponentBuilder,
 	ComponentEmojiResolvable,
-	JSONEncodable
+	JSONEncodable,
+	RestOrArray,
+	normalizeArray
 } from 'discord.js';
-import type { PAttachments, ButtonsOptions, ButtonStyle, PEmbeds, EmojiOptions, LabelOptions, Options, Payload } from '../types';
+import { PAttachments, ButtonsOptions, ButtonStyle, PEmbeds, EmojiOptions, LabelOptions, Options, Payload, ExtraRowPosition } from '../types';
 import { defaultOptions } from './defaultOptions';
 
 /**
@@ -172,7 +174,7 @@ export abstract class PaginationEmbed extends EmbedBuilder {
 	 */
 	private extraRows: {
 		rows: ActionRowBuilder<MessageActionRowComponentBuilder>[];
-		position: 'above' | 'below';
+		position: ExtraRowPosition;
 	}[];
 
 	/**
@@ -248,13 +250,19 @@ export abstract class PaginationEmbed extends EmbedBuilder {
 		this.setOptions(mergedOptions);
 	}
 
-	public override setFields(fields: APIEmbedField[]): this {
-		this.rawFields = fields;
+	public override addFields(...fields: RestOrArray<APIEmbedField>): this {
+		this.rawFields.push(...normalizeArray(fields));
 		return this;
 	}
 
-	public override addFields(fields: APIEmbedField[]): this {
-		this.rawFields.push(...fields);
+	public spliceFields(index: number, deleteCount: number, ...fields: APIEmbedField[]): this {
+		if (this.data.fields) this.data.fields.splice(index, deleteCount, ...fields);
+		else this.data.fields = fields;
+		return this;
+	}
+
+	public override setFields(...fields: RestOrArray<APIEmbedField>): this {
+		this.rawFields = normalizeArray(fields);
 		return this;
 	}
 
@@ -319,25 +327,8 @@ export abstract class PaginationEmbed extends EmbedBuilder {
 	 * ```
 	 *
 	 */
-	public setImages(images: string[]): this {
-		this.images = images;
-		return this;
-	}
-
-	/**
-	 * Adds a pagination image.
-	 * @param image
-	 * @returns
-	 * @example
-	 * ```javascript
-	 * const pagination = new Pagination(interaction)
-	 *  .setImages(["1st image", "2nd image", "3rd image"])
-	 *  .addImage("4st image");
-	 * ```
-	 *
-	 */
-	public addImage(image: string): this {
-		this.images.push(image);
+	public setImages(...images: RestOrArray<string>): this {
+		this.images = normalizeArray(images);
 		return this;
 	}
 
@@ -353,8 +344,8 @@ export abstract class PaginationEmbed extends EmbedBuilder {
 	 * ```
 	 *
 	 */
-	public addImages(images: string[]): this {
-		this.images.push(...images);
+	public addImages(...images: RestOrArray<string>): this {
+		this.images.push(...normalizeArray(images));
 		return this;
 	}
 
@@ -369,25 +360,8 @@ export abstract class PaginationEmbed extends EmbedBuilder {
 	 * ```
 	 *
 	 */
-	public setDescriptions(descriptions: string[]): this {
-		this.descriptions = descriptions;
-		return this;
-	}
-
-	/**
-	 * Adds a pagination description.
-	 * @param description
-	 * @returns
-	 * @example
-	 * ```javascript
-	 * const pagination = new Pagination(interaction)
-	 *  .setDescriptions(["1st description", "2nd description", "3rd description"])
-	 *  .addDescription("4st description");
-	 * ```
-	 *
-	 */
-	public addDescription(description: string): this {
-		this.descriptions.push(description);
+	public setDescriptions(...descriptions: RestOrArray<string>): this {
+		this.descriptions = normalizeArray(descriptions);
 		return this;
 	}
 
@@ -403,8 +377,8 @@ export abstract class PaginationEmbed extends EmbedBuilder {
 	 * ```
 	 *
 	 */
-	public addDescriptions(descriptions: string[]): this {
-		this.descriptions.push(...descriptions);
+	public addDescriptions(...descriptions: RestOrArray<string>): this {
+		this.descriptions.push(...normalizeArray(descriptions));
 		return this;
 	}
 
@@ -431,23 +405,6 @@ export abstract class PaginationEmbed extends EmbedBuilder {
 		return this;
 	}
 
-	/**
-	 * Adds a pagination embed.
-	 * @param embed
-	 * @returns
-	 * @example
-	 * ```javascript
-	 * const pagination = new Pagination(interaction)
-	 *  .setEmbeds([new EmbedBuilder(), new EmbedBuilder(), new EmbedBuilder()])
-	 *  .addEmbed(new EmbedBuilder);
-	 * ```
-	 *
-	 */
-	public addEmbed(embed: PEmbeds[number]): this {
-		this.embeds.push(embed);
-		return this;
-	}
-
 	/**
 	 * Adds multiple pagination embeds.
 	 * @param embeds An array of {@link EmbedBuilder} or {@link EmbedBuilderOptions}
@@ -710,7 +667,7 @@ export abstract class PaginationEmbed extends EmbedBuilder {
 	 * ```
 	 *
 	 */
-	public addActionRows(actionRows: ActionRowBuilder<MessageActionRowComponentBuilder>[], position: 'below' | 'above' = 'below'): this {
+	public addActionRows(actionRows: ActionRowBuilder<MessageActionRowComponentBuilder>[], position = ExtraRowPosition.Below): this {
 		this.extraRows.push({
 			rows: actionRows,
 			position
@@ -992,7 +949,7 @@ export abstract class PaginationEmbed extends EmbedBuilder {
 		this.actionRows = [this.mainActionRow];
 		if (this.extraRows.length > 0) {
 			this.extraRows.forEach((row) => {
-				row.position === 'above' ? this.actionRows.unshift(...row.rows) : this.actionRows.push(...row.rows);
+				row.position === ExtraRowPosition.Above ? this.actionRows.unshift(...row.rows) : this.actionRows.push(...row.rows);
 			});
 		}
 		return this;

diff --git a/src/lib/types/Options.ts b/src/lib/types/Options.ts
@@ -5,6 +5,11 @@ import type { EmojiOptions } from './EmojiOptions';
 export type PEmbeds = Required<MessageOptions>['embeds'];
 export type PAttachments = Required<MessageOptions>['files'];
 
+export enum ExtraRowPosition {
+	Above,
+	Below
+}
+
 /**
  * The options to customize the pagination.
  */