djs-builder 0.5.10 → 0.5.20

package/lib/discord/builder/system/Pagination.ts

@@ -1,321 +1,318 @@
 import {
-    ActionRowBuilder,
     ButtonBuilder,
+    ActionRowBuilder,
     EmbedBuilder,
+    Message,
+    MessageComponentInteraction,
+    MessageActionRowComponentBuilder,
     ButtonStyle,
     StringSelectMenuBuilder,
-    TextChannel,
-    Message,
-    Interaction,
-    ButtonInteraction,
-    StringSelectMenuInteraction,
-} from 'discord.js';
-
-interface ButtonSettings {
-    label: string;
-    style: ButtonStyle;
-    emoji?: string;
-    onClick?: () => void;
-}
-
-interface EmbedOptions {
-    homePage: number;
-    embeds: EmbedBuilder[];
-    defaultPage: number;
-    dynamicUpdate?: (currentPage: number) => EmbedBuilder;
-}
-
-interface TimeoutOptions {
-    duration: number;
-    disableComponents: boolean;
-    onTimeout?: () => void;
-}
-
-interface PaginationOptions {
-    embedOptions: EmbedOptions;
-    timeoutOptions?: TimeoutOptions;
-    restrictToUser?: string | null;
-    navigationMenu?: boolean;
-    loopNavigation?: boolean;
-    buttonSettings?: {
-        first?: ButtonSettings;
-        previous?: ButtonSettings;
-        home?: ButtonSettings;
-        next?: ButtonSettings;
-        last?: ButtonSettings;
+    StringSelectMenuInteraction
+  } from "discord.js";
+  
+  interface PagerOptions {
+    firstLast?: boolean;
+    deleteOption?: boolean;
+    otherComponents?: ActionRowBuilder<MessageActionRowComponentBuilder>[];
+    home?: {
+      home_Option?: boolean;
+      home_page?: number;
     };
-    additionalComponents?: ActionRowBuilder<any>[];
-    attachments?: any[];
-    content?: string;
-    channel?: TextChannel;
-    context?: Interaction;
-    autoRefresh?: {
-        interval: number;
-        updateContent: () => void;
+    timeOption?: {
+      timeOut?: number;
+      disable?: boolean;
+      deletes?: boolean;
+      custom?: (() => void);
     };
-}
-
-export class Pagination {
-    private embedOptions: EmbedOptions;
-    private timeoutOptions: TimeoutOptions;
-    private restrictToUser: string | null;
-    private navigationMenu: boolean;
-    private loopNavigation: boolean;
-    private buttonSettings: {
-        first?: ButtonSettings;
-        previous?: ButtonSettings;
-        home?: ButtonSettings;
-        next?: ButtonSettings;
-        last?: ButtonSettings;
+    user_only?: {
+      user_status?: boolean;
+      reply?: string;
     };
-    private additionalComponents: ActionRowBuilder<any>[];
-    private attachments: any[];
-    private content: string | null;
-    private channel?: TextChannel;
-    private context?: Interaction;
-    private components: ActionRowBuilder<any>[];
-    private message?: Message;
-    private autoRefresh?: {
-        interval: number;
-        updateContent: () => void;
+    style?: {
+      nextAndBack?: ButtonStyle;
+      firstAndLast?: ButtonStyle;
+      homeStyle?: ButtonStyle;
+      deleteStyle?: ButtonStyle;
     };
-
-    constructor({
-        embedOptions,
-        timeoutOptions = { duration: 60000, disableComponents: true },
-        restrictToUser = null,
-        navigationMenu = false,
-        loopNavigation = true,
-        buttonSettings = {
-            first: { label: 'First', style: ButtonStyle.Primary },
-            previous: { label: 'Previous', style: ButtonStyle.Secondary },
-            home: { label: 'Home', style: ButtonStyle.Success },
-            next: { label: 'Next', style: ButtonStyle.Secondary },
-            last: { label: 'Last', style: ButtonStyle.Primary },
-        },
-        additionalComponents = [],
-        attachments = [],
-        content = '',
-        channel,
-        context,
-        autoRefresh,
-    }: PaginationOptions) {
-        if (navigationMenu && (embedOptions.embeds.length < 1 || embedOptions.embeds.length > 25)) {
-            throw new Error('The number of embeds must be between 1 and 25 to use the navigation menu.');
-        }
-
-        this.embedOptions = embedOptions;
-        this.timeoutOptions = timeoutOptions;
-        this.restrictToUser = restrictToUser;
-        this.navigationMenu = navigationMenu;
-        this.loopNavigation = loopNavigation;
-        this.buttonSettings = buttonSettings;
-        this.additionalComponents = additionalComponents;
-        this.attachments = attachments;
-        this.content = content;
-        this.channel = channel;
-        this.context = context;
-        this.autoRefresh = autoRefresh;
-
-        this.components = this.createPaginationRows();
-
-        if (this.navigationMenu) {
-            this.components.push(
-                new ActionRowBuilder<StringSelectMenuBuilder>().addComponents(
-                    new StringSelectMenuBuilder()
-                        .setCustomId('select-djs-builder')
-                        .setPlaceholder('Select a page')
-                        .addOptions(
-                            this.embedOptions.embeds.map((_, index) => ({
-                                label: `Page ${index + 1}`,
-                                value: index.toString(),
-                            }))
-                        )
-                )
-            );
-        }
-
-        if (this.additionalComponents.length > 0) {
-            this.additionalComponents.forEach((row) => {
-                if (row.components.length > 5) {
-                    this.splitComponentsIntoRows(row.components).forEach((rowComponents) => {
-                        this.components.push(new ActionRowBuilder().addComponents(rowComponents));
-                    });
-                } else {
-                    this.components.push(row);
-                }
-            });
-        }
-
-        if (this.autoRefresh) {
-            setInterval(() => {
-                this.autoRefresh!.updateContent();
-                this.message?.edit({
-                    embeds: [this.getEmbed()],
-                    components: this.components,
-                });
-            }, this.autoRefresh.interval);
-        }
+    label?: {
+      labelNext?: string | null;
+      labelBack?: string | null;
+      labelFirst?: string | null;
+      labelLast?: string | null;
+      labelHome?: string | null;
+      labelDelete?: string | null;
+    };
+    emoji?: {
+      emojiNext?: string;
+      emojiBack?: string;
+      emojiFirst?: string;
+      emojiLast?: string;
+      emojiHome?: string;
+      emojiDelete?: string;
+    };
+    pages?: {
+      embeds?: EmbedBuilder[];
+      attachment?: (string | Buffer)[];
+      content?: string[];
+    };
+    navigationMenu?: boolean; 
+  }
+  
+  const CUSTOM_IDS = {
+    NEXT: "next-djs-builder",
+    BACK: "back-djs-builder",
+    FIRST: "first-djs-builder",
+    LAST: "last-djs-builder",
+    DELETE: "delete-djs-builder",
+    HOME: "home-djs-builder",
+    SELECT: "select-djs-builder"
+  };
+  
+  const VALID_BUTTON_STYLES = [
+    ButtonStyle.Primary,
+    ButtonStyle.Secondary,
+    ButtonStyle.Success,
+    ButtonStyle.Danger
+  ];
+  
+  const isValidEmoji = (emoji: string | undefined): boolean => {
+    if (!emoji) return false;
+    const unicodeEmojiPattern = /^[\u{1F600}-\u{1F64F}\u{1F300}-\u{1F5FF}\u{1F680}-\u{1F6FF}\u{1F700}-\u{1F77F}\u{1F780}-\u{1F7FF}\u{1F800}-\u{1F8FF}\u{1F900}-\u{1F9FF}\u{1FA00}-\u{1FA6F}\u{1FA70}-\u{1FAFF}\u{2600}-\u{26FF}\u{2700}-\u{27BF}\u{2300}-\u{23FF}\u{2B50}\u{2934}\u{2935}\u{3030}]+$/u;
+    return unicodeEmojiPattern.test(emoji) || /^\d+$/.test(emoji);
+  };
+  
+  export class Pagination {
+    private message: Message;
+    private options: Required<PagerOptions>;
+    private buttons: ButtonBuilder[];
+    private components: ActionRowBuilder<MessageActionRowComponentBuilder>[];
+    private selectMenus: ActionRowBuilder<StringSelectMenuBuilder>[];
+    private naw_page: number = 0;
+    
+  
+    constructor(message: Message, options: PagerOptions) {
+      this.message = message;
+      this.options = {
+        firstLast: false,
+        deleteOption: false,
+        otherComponents: [],
+        home: { home_Option: false, home_page: 0 },
+        timeOption: { timeOut: 86400000, disable: false, deletes: false, custom: undefined },
+        user_only: { user_status: false, reply: "You are not the command owner" },
+        style: { nextAndBack: ButtonStyle.Primary, firstAndLast: ButtonStyle.Secondary, homeStyle: ButtonStyle.Success, deleteStyle: ButtonStyle.Danger },
+        label: {},
+        emoji: { emojiNext: "➡", emojiBack: "⬅", emojiFirst: "⏪", emojiLast: "⏩", emojiHome: "🏠", emojiDelete: "🗑" },
+        pages: { embeds: [], attachment: [], content: [] },
+        navigationMenu: false,
+        ...options,
+      };
+  
+      this.validateOptions();
+      this.buttons = this.createButtons();
+      this.components = this.createComponents();
+      this.selectMenus = this.createSelectMenus();
     }
-
-    private createPaginationRows(): ActionRowBuilder<ButtonBuilder>[] {
-        const rows: ActionRowBuilder<ButtonBuilder>[] = [];
-        const buttons = [
-            { id: 'first-djs-builder', settings: this.buttonSettings.first },
-            { id: 'previous-djs-builder', settings: this.buttonSettings.previous },
-            { id: 'home-djs-builder', settings: this.buttonSettings.home },
-            { id: 'next-djs-builder', settings: this.buttonSettings.next },
-            { id: 'last-djs-builder', settings: this.buttonSettings.last },
-        ];
-
-        while (buttons.length > 0) {
-            const row = new ActionRowBuilder<ButtonBuilder>();
-            for (let i = 0; i < 5 && buttons.length > 0; i++) {
-                const { id, settings } = buttons.shift()!;
-                if (settings) {
-                    row.addComponents(this.createButton(id, settings));
-                }
-            }
-            rows.push(row);
-        }
-
-        return rows;
+  
+    private validateOptions() {
+      const { emoji } = this.options;
+      if (!Object.values(emoji).every(isValidEmoji)) {
+        throw new Error("Invalid emoji format. Must be either Unicode emojis or valid emoji IDs.");
+      }
+  
+      const { style } = this.options;
+      if (!Object.values(style).every(style => VALID_BUTTON_STYLES.includes(style))) {
+        throw new Error("Invalid button style. Must be one of the predefined ButtonStyle values.");
+      }
+  
+      if (this.options.deleteOption && this.options.home?.home_Option) {
+        throw new Error("You can't use 'home' and 'delete' together.");
+      }
+  
+      if (this.options.timeOption?.disable && this.options.timeOption?.deletes) {
+        throw new Error("You can't use 'disable' and 'deletes' together.");
+      }
     }
-
-    private splitComponentsIntoRows(components: ButtonBuilder[]): ButtonBuilder[][] {
-        const rows: ButtonBuilder[][] = [];
-        while (components.length > 0) {
-            rows.push(components.splice(0, 5));
-        }
-        return rows;
+  
+    private createButtons(): ButtonBuilder[] {
+      const {
+        nextAndBack,
+        firstAndLast,
+        homeStyle,
+        deleteStyle,
+      } = this.options.style;
+  
+      const {
+        emojiNext,
+        emojiBack,
+        emojiFirst,
+        emojiLast,
+        emojiHome,
+        emojiDelete,
+      } = this.options.emoji;
+  
+      const next = new ButtonBuilder().setCustomId(CUSTOM_IDS.NEXT).setEmoji(emojiNext!).setStyle(nextAndBack!);
+      const back = new ButtonBuilder().setCustomId(CUSTOM_IDS.BACK).setEmoji(emojiBack!).setStyle(nextAndBack!);
+      const first = new ButtonBuilder().setCustomId(CUSTOM_IDS.FIRST).setEmoji(emojiFirst!).setStyle(firstAndLast!);
+      const last = new ButtonBuilder().setCustomId(CUSTOM_IDS.LAST).setEmoji(emojiLast!).setStyle(firstAndLast!);
+      const home = new ButtonBuilder().setCustomId(CUSTOM_IDS.HOME).setEmoji(emojiHome!).setStyle(homeStyle!);
+      const deleteBtn = new ButtonBuilder().setCustomId(CUSTOM_IDS.DELETE).setEmoji(emojiDelete!).setStyle(deleteStyle!);
+  
+      const {
+        labelNext,
+        labelBack,
+        labelFirst,
+        labelLast,
+        labelHome,
+        labelDelete,
+      } = this.options.label;
+  
+      if (labelNext) next.setLabel(labelNext);
+      if (labelBack) back.setLabel(labelBack);
+      if (labelFirst) first.setLabel(labelFirst);
+      if (labelLast) last.setLabel(labelLast);
+      if (labelHome) home.setLabel(labelHome);
+      if (labelDelete) deleteBtn.setLabel(labelDelete);
+  
+      const buttons: ButtonBuilder[] = [];
+  
+      if (this.options.firstLast) buttons.push(first);
+      buttons.push(back);
+      if (this.options.home?.home_Option) buttons.push(home);
+      else if (this.options.deleteOption) buttons.push(deleteBtn);
+      buttons.push(next);
+      if (this.options.firstLast) buttons.push(last);
+  
+      return buttons;
     }
-
-    private createButton(id: string, settings?: ButtonSettings): ButtonBuilder {
-        const button = new ButtonBuilder()
-            .setCustomId(id)
-            .setLabel(settings?.label ?? '')
-            .setStyle(settings?.style ?? ButtonStyle.Secondary);
-
-        if (settings?.emoji) {
-            button.setEmoji(settings.emoji);
+  
+    private createComponents(): ActionRowBuilder<MessageActionRowComponentBuilder>[] {
+        const buttonRow = new ActionRowBuilder<MessageActionRowComponentBuilder>().addComponents(this.buttons);
+      
+        const otherRows = this.options.otherComponents || [];
+        const selectMenus = this.options.navigationMenu ? this.createSelectMenus() : [];
+      
+        return [buttonRow, ...selectMenus, ...otherRows];
+      }
+          
+      private createSelectMenus(): ActionRowBuilder<StringSelectMenuBuilder>[] {
+        const { embeds = [], content = [], attachment = [] } = this.options.pages || {};
+        const longest_length = Math.max(embeds.length, content.length, attachment.length);
+      
+        const selectMenus: ActionRowBuilder<StringSelectMenuBuilder>[] = [];
+        for (let i = 0; i < longest_length; i += 25) {
+          const menuOptions = Array.from({ length: Math.min(25, longest_length - i) }, (_, j) => ({
+            label: `Page ${i + j + 1}`,
+            value: `${i + j}`
+          }));
+      
+          const selectMenu = new StringSelectMenuBuilder()
+            .setCustomId(`select_${i}`)
+            .setPlaceholder("Choose a page")
+            .addOptions(menuOptions);
+      
+          selectMenus.push(new ActionRowBuilder<StringSelectMenuBuilder>().addComponents(selectMenu));
         }
-
-        return button;
-    }
-
-    private getEmbed(): EmbedBuilder {
-        return this.embedOptions.dynamicUpdate 
-            ? this.embedOptions.dynamicUpdate(this.embedOptions.defaultPage)
-            : this.embedOptions.embeds[this.embedOptions.defaultPage];
-    }
-
-    private async handleInteraction(interaction: ButtonInteraction | StringSelectMenuInteraction): Promise<void> {
-        if (this.restrictToUser && interaction.user.id !== this.restrictToUser) {
-            await interaction.reply({ content: "You can't use these buttons!", ephemeral: true });
-            return;
+      
+        return selectMenus;
+      }
+      
+      public async send() {
+        const { embeds = [], content = [], attachment = [] } = this.options.pages || {};
+    
+        if (embeds.length === 0) {
+          throw new Error("No embeds provided.");
         }
-
-        const { customId, values } = interaction as any;
-
-        const buttonAction = this.buttonSettings[customId as keyof typeof this.buttonSettings]?.onClick;
-        if (buttonAction) {
-            buttonAction();
+    
+        try {
+          const msg = await this.message.reply({
+            embeds: [embeds[0]],
+            content: content[0] || "",
+            files: attachment[0] ? [attachment[0]] : [],
+            components: this.components,
+          });
+    
+          const collector = this.createCollector(msg);
+          collector.on("collect", async (i: MessageComponentInteraction) => this.handleCollect(i));
+          collector.on("end", async () => this.handleEnd(msg));
+        } catch (error) {
+          console.error("Error sending message:", error);
         }
-
-        switch (customId) {
-            case 'first-djs-builder':
-                this.embedOptions.defaultPage = 0;
-                break;
-            case 'previous-djs-builder':
-                this.embedOptions.defaultPage = this.loopNavigation && this.embedOptions.defaultPage === 0
-                    ? this.embedOptions.embeds.length - 1
-                    : Math.max(this.embedOptions.defaultPage - 1, 0);
-                break;
-            case 'next-djs-builder':
-                this.embedOptions.defaultPage = this.loopNavigation && this.embedOptions.defaultPage === this.embedOptions.embeds.length - 1
-                    ? 0
-                    : Math.min(this.embedOptions.defaultPage + 1, this.embedOptions.embeds.length - 1);
+      }
+    
+      private createCollector(msg: Message) {
+        const filter = this.options.user_only?.user_status
+          ? async (i: MessageComponentInteraction) => {
+              if (i.user.id !== this.message.author.id) {
+                await i.reply({ content: this.options.user_only.reply!, ephemeral: true });
+                return false;
+              }
+              return true;
+            }
+          : undefined;
+    
+        return msg.createMessageComponentCollector({
+          filter,
+          time: this.options.timeOption?.timeOut || 86400000,
+        });
+      }
+      
+      private async handleCollect(i: MessageComponentInteraction) {
+        const { embeds = [], content = [], attachment = [] } = this.options.pages || {};
+        const num = embeds.length;
+      
+        try {
+          if (i.isButton()) {
+            switch (i.customId) {
+              case CUSTOM_IDS.NEXT:
+                this.naw_page = (this.naw_page + 1) % num;
                 break;
-            case 'last-djs-builder':
-                this.embedOptions.defaultPage = this.embedOptions.embeds.length - 1;
+              case CUSTOM_IDS.BACK:
+                this.naw_page = (this.naw_page - 1 + num) % num;
                 break;
-            case 'home-djs-builder':
-                this.embedOptions.defaultPage = this.embedOptions.homePage;
+              case CUSTOM_IDS.FIRST:
+                this.naw_page = 0;
                 break;
-            case 'select-djs-builder':
-                this.embedOptions.defaultPage = parseInt(values[0], 10);
+              case CUSTOM_IDS.LAST:
+                this.naw_page = num - 1;
                 break;
-            default:
+              case CUSTOM_IDS.DELETE:
+                await i.message.delete();
+                return;
+              case CUSTOM_IDS.HOME:
+                this.naw_page = this.options.home?.home_page || 0;
                 break;
-        }
-
-        if (this.message) {
-            await interaction.deferUpdate();
-            await this.message.edit({
-                embeds: [this.getEmbed()],
-                components: this.components,
-                content: this.content ?? undefined,
-                files: this.attachments.length ? this.attachments : undefined,
-            });
-        } else if (this.channel) {
-            this.message = await this.channel.send({
-                embeds: [this.getEmbed()],
-                components: this.components,
-                content: this.content ?? undefined,
-                files: this.attachments.length ? this.attachments : undefined,
-            });
-            this.createCollector(this.message);
-        } else if (this.context) {
-            // @ts-ignore
-            this.message = await this.context.reply({
-                embeds: [this.getEmbed()],
-                components: this.components,
-                content: this.content ?? undefined,
-                files: this.attachments.length ? this.attachments : undefined,
-            }) as Message;
-            // @ts-ignore
-            this.message = await this.context.fetchReply() as Message;
-            this.createCollector(this.message);
-        } else {
-            throw new Error('You must specify either a context or a channel.');
-        }
-    }
-
-    public async send(): Promise<void> {
-        if (this.context || this.channel) {
-            // @ts-ignore
-            await this.handleInteraction({ customId: '', values: [] } as ButtonInteraction);
-        } else {
-            throw new Error('You must specify either a context or a channel.');
-        }
-    }
-
-    private createCollector(message: Message): void {
-        const collector = message.createMessageComponentCollector({
-            filter: (i) => i.isButton() || i.isStringSelectMenu(),
-            time: this.timeoutOptions.duration,
-        });
-
-        collector.on('collect', async (interaction) => {
-            if (interaction.isButton() || interaction.isStringSelectMenu()) {
-                await this.handleInteraction(interaction);
-            }
-        });
-
-        collector.on('end', async () => {
-            if (this.timeoutOptions.onTimeout) {
-                this.timeoutOptions.onTimeout();
             }
-            if (!this.timeoutOptions.disableComponents) {
-                await message.edit({ components: [] });
-            } else {
-                await message.edit({
-                    // @ts-ignore
-                    components: this.components.map((row) => 
-                        row.components.map((component) => component.setDisabled(true))
-                    ),
-                });
+          } else if (i.isStringSelectMenu()) {
+            if (i.customId === "select-djs-builder") {
+              this.naw_page = parseInt(i.values[0], 10);
             }
-        });
+          }
+          await i.update({
+            embeds: [embeds[this.naw_page]],
+            content: content[this.naw_page] || "",
+            files: attachment[this.naw_page] ? [attachment[this.naw_page]] : [],
+            components: this.createComponents(),
+          });
+        } catch (error) {
+          console.error("Error handling interaction:", error);
+        }
+      }
+            
+      private async handleEnd(msg: Message) {
+        try {
+          if (this.options.timeOption?.disable) {
+            this.components[0].components.forEach((button) => button.setDisabled(true));
+            await msg.edit({ components: this.components });
+          }
+          if (this.options.timeOption?.deletes) {
+            await msg.edit({ components: [] });
+          }
+          if (typeof this.options.timeOption?.custom === "function") {
+            this.options.timeOption.custom();
+          }
+        } catch (error) {
+          console.error("Error handling end of collector:", error);
+        }
+      }
     }
-}
+    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "djs-builder",
-  "version": "0.5.10",
+  "version": "0.5.20",
   "description": "Discord.js bot builder. Supports Ts and Js.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",