NatsukiDev
/
Natsuki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Finish pagination class

Browse Source
master
Kit Kasune 4 years ago
parent bf85026445
commit 6d98489038
6 changed files with 274 additions and 19 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 44
      commands/testpage.js
  2. 34
      package-lock.json
  3. 1
      package.json
  4. 24
      util/pagination.d.ts
  5. 82
      util/pagination.js
  6. 108
      util/ts/pagination.ts

44
commands/testpage.js
Unescape View File

@ -0,0 +1,44 @@
const Discord = require('discord.js');
const {Pagination} = require('../util/pagination');
module.exports = {
name: "testpage",
aliases: ['tp'],
meta: {
category: "",
perms: "",
staff: false,
vip: "",
serverPerms: [],
writtenBy: "",
serverOnly: false
},
tags: [],
help: new Discord.MessageEmbed()
.setTitle("Help -> ")
.setDescription("")
.addField("Syntax", "``"),
async execute(message, msg, args, cmd, prefix, mention, client) {
let p = await new Pagination(message.channel, [
new Discord.MessageEmbed()
.setTitle("bonk")
.setDescription("bonk horny jail")
.addField("bonk", "you have been bonked")
.setColor('c375f0'),
new Discord.MessageEmbed()
.setTitle("stonks")
.setDescription("yeet")
.setColor('c375f0'),
new Discord.MessageEmbed()
.setTitle("honks")
.setDescription("such wow many honks")
.addField("aye", "lul text")
.setColor('c375f0'),
new Discord.MessageEmbed()
.setTitle("yoink")
.setDescription("give me the vibes")
.addField("vibecheck", "your vibe will now be checked.")
.setColor('c375f0'),
], message, client).start({endTime: 60000, user: message.author.id});
}
};

34
package-lock.json generated
Unescape View File

@ -806,6 +806,11 @@
"requires": { "requires": {
"has-flag": "^3.0.0" "has-flag": "^3.0.0"
} }
},
"urijs": {
"version": "1.19.2",
"resolved": "https://registry.npmjs.org/urijs/-/urijs-1.19.2.tgz",
"integrity": "sha512-s/UIq9ap4JPZ7H1EB5ULo/aOUbWqfDi7FKzMC2Nz+0Si8GiT1rIEaprt8hy3Vy2Ex2aJPpOQv4P4DuOZ+K1c6w=="
} }
} }
}, },
@ -7032,9 +7037,9 @@
"integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
}, },
"ini": { "ini": {
"version": "1.3.5", "version": "1.3.8",
"resolved": "https://registry.npmjs.org/ini/-/ini-1.3.5.tgz", "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz",
"integrity": "sha512-RZY5huIKCMRWDUqZlEi72f/lmXKMvuszcMBduliQ3nnWbx9X/ZBQO7DijMEYS9EhHBb2qacRUMtC7svLwe0lcw==" "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew=="
}, },
"inquirer": { "inquirer": {
"version": "7.3.3", "version": "7.3.3",
@ -8777,6 +8782,23 @@
} }
} }
}, },
"swwrap": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/swwrap/-/swwrap-1.0.0.tgz",
"integrity": "sha512-Hjpa/2giqpQR7Few0RHZ09X7Y/tfvlyuY0dJTVxQ05ifX1SGrbYSo+C28CLJh8owkKxvCgnYmitng6t6UiQSag==",
"requires": {
"@types/node": "^14.14.20",
"node-fetch": "^2.6.1",
"typescript": "^3.9.7"
},
"dependencies": {
"@types/node": {
"version": "14.14.20",
"resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.20.tgz",
"integrity": "sha512-Y93R97Ouif9JEOWPIUyU+eyIdyRqQR0I8Ez1dzku4hDx34NWh4HbtIc3WNzwB1Y9ULvNGeu5B8h8bVL5cAk4/A=="
}
}
},
"tar": { "tar": {
"version": "6.0.5", "version": "6.0.5",
"resolved": "https://registry.npmjs.org/tar/-/tar-6.0.5.tgz", "resolved": "https://registry.npmjs.org/tar/-/tar-6.0.5.tgz",
@ -9024,9 +9046,9 @@
"integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=" "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw="
}, },
"urijs": { "urijs": {
"version": "1.19.2", "version": "1.19.5",
"resolved": "https://registry.npmjs.org/urijs/-/urijs-1.19.2.tgz", "resolved": "https://registry.npmjs.org/urijs/-/urijs-1.19.5.tgz",
"integrity": "sha512-s/UIq9ap4JPZ7H1EB5ULo/aOUbWqfDi7FKzMC2Nz+0Si8GiT1rIEaprt8hy3Vy2Ex2aJPpOQv4P4DuOZ+K1c6w==" "integrity": "sha512-48z9VGWwdCV5KfizHsE05DWS5fhK6gFlx5MjO7xu0Krc5FGPWzjlXEVV0nPMrdVuP7xmMHiPZ2HoYZwKOFTZOg=="
}, },
"url-parse": { "url-parse": {
"version": "1.4.7", "version": "1.4.7",

1
package.json
Unescape View File

@ -21,6 +21,7 @@
"node-fetch": "^2.6.1", "node-fetch": "^2.6.1",
"sequelize": "^5.22.3", "sequelize": "^5.22.3",
"sqlite3": "^4.2.0", "sqlite3": "^4.2.0",
"swwrap": "^1.0.0",
"winston": "^3.3.3", "winston": "^3.3.3",
"ytdl-core": "^3.2.2", "ytdl-core": "^3.2.2",
"ytdl-core-discord": "^1.2.1" "ytdl-core-discord": "^1.2.1"

24
util/pagination.d.ts vendored
Unescape View File

@ -1,4 +1,4 @@
import { TextChannel, Message, MessageEmbed, Client } from 'discord.js'; import { TextChannel, Message, MessageEmbed, Client, ReactionCollector } from 'discord.js';
export declare class Pagination { export declare class Pagination {
channel: TextChannel; channel: TextChannel;
message: Message; message: Message;
@ -6,10 +6,30 @@ export declare class Pagination {
originalMessage: Message; originalMessage: Message;
currentPage: number; currentPage: number;
client: Client; client: Client;
constructor(channel: TextChannel, pages: MessageEmbed[], originalMessage: Message, client: Client, message?: Message); loopPages: boolean;
controllers: ControllerData;
constructor(channel: TextChannel, pages: MessageEmbed[], originalMessage: Message, client: Client, loopPages?: boolean, message?: Message);
setPage(page: number): Promise<Pagination>; setPage(page: number): Promise<Pagination>;
nextPage(): Promise<Pagination>; nextPage(): Promise<Pagination>;
prevPage(): Promise<Pagination>; prevPage(): Promise<Pagination>;
addPage(page: MessageEmbed): Pagination; addPage(page: MessageEmbed): Pagination;
replacePage(index: number, page: MessageEmbed): Pagination; replacePage(index: number, page: MessageEmbed): Pagination;
setControllers(endTime: number, user?: 'any' | string, extraControls?: ExtraControls): Promise<Pagination>;
updateControllers(): Promise<Pagination>;
endControllers(): Promise<Pagination>;
start(options?: {
endTime?: number;
startPage?: number;
user?: 'any' | string;
}): Promise<Pagination>;
stop(): Promise<Pagination>;
} }
interface ExtraControls {
}
interface ControllerData {
endTime: number;
enabled: boolean;
lastInteraction: Date;
collector: ReactionCollector;
}
export {};

82
util/pagination.js
Unescape View File

@ -2,7 +2,9 @@
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
exports.Pagination = void 0; exports.Pagination = void 0;
class Pagination { class Pagination {
constructor(channel, pages, originalMessage, client, message) { constructor(channel, pages, originalMessage, client, loopPages, message) {
this.loopPages = true;
this.controllers = { enabled: false, endTime: null, collector: null, lastInteraction: null };
this.channel = channel; this.channel = channel;
this.pages = pages; this.pages = pages;
this.originalMessage = message; this.originalMessage = message;
@ -11,6 +13,9 @@ class Pagination {
if (message) { if (message) {
this.message = message; this.message = message;
} }
if (loopPages) {
this.loopPages = loopPages;
}
} }
; ;
async setPage(page) { async setPage(page) {
@ -25,7 +30,7 @@ class Pagination {
this.message = tempm; this.message = tempm;
} }
} }
await this.message.edit(this.pages[page] await this.message.edit('', this.pages[page]
.setFooter(`Natsuki | Page ${page + 1} of ${this.pages.length}`, this.client.user.avatarURL()) .setFooter(`Natsuki | Page ${page + 1} of ${this.pages.length}`, this.client.user.avatarURL())
.setTimestamp()); .setTimestamp());
this.currentPage = page; this.currentPage = page;
@ -33,12 +38,24 @@ class Pagination {
} }
; ;
async nextPage() { async nextPage() {
await this.setPage(typeof this.currentPage === "number" ? this.currentPage + 1 == this.pages.length ? this.currentPage : this.currentPage + 1 : 0); await this.setPage(typeof this.currentPage === "number"
? this.currentPage + 1 == this.pages.length
? this.loopPages
? 0
: this.currentPage
: this.currentPage + 1
: 0);
return this; return this;
} }
; ;
async prevPage() { async prevPage() {
await this.setPage(typeof this.currentPage === "number" ? this.currentPage === 0 ? 0 : this.currentPage - 1 : this.pages.length - 1); await this.setPage(typeof this.currentPage === "number"
? this.currentPage === 0
? this.loopPages
? this.pages.length - 1
: 0
: this.currentPage - 1
: this.pages.length - 1);
return this; return this;
} }
; ;
@ -46,6 +63,7 @@ class Pagination {
this.pages.push(page); this.pages.push(page);
return this; return this;
} }
;
replacePage(index, page) { replacePage(index, page) {
if (index < 0) { if (index < 0) {
throw new RangeError("replacePage() param 'index' must be a value greater than 0"); throw new RangeError("replacePage() param 'index' must be a value greater than 0");
@ -56,5 +74,61 @@ class Pagination {
this.pages[index] = page; this.pages[index] = page;
return this; return this;
} }
;
async setControllers(endTime, user, extraControls) {
if (this.controllers.enabled) {
return;
}
await this.message.react('⬅');
await this.message.react('➡');
await this.message.react('⏹');
let emoji = ['⬅', '➡', '⏹'];
let filter = user && user.toLowerCase().trim() !== 'any'
? (r, u) => { return u.id === user.trim() && emoji.includes(r.emoji.name); }
: (r) => { return emoji.includes(r.emoji.name); };
this.controllers.collector = this.message.createReactionCollector(filter, { time: 450000 });
this.controllers.collector.on('collect', async (r) => {
console.log(r);
let functions = {
'⬅': () => { return this.prevPage(); },
'➡': () => { return this.nextPage(); },
'⏹': () => { return this.endControllers(); }
};
this.controllers.lastInteraction = new Date();
return functions[r.emoji.name]();
});
this.controllers.enabled = true;
this.controllers.endTime = endTime;
this.controllers.lastInteraction = new Date();
setInterval(() => {
if (new Date().getTime() - this.controllers.lastInteraction.getTime() > this.controllers.endTime) {
return this.endControllers();
}
}, this.controllers.endTime);
return this;
}
;
async updateControllers() { return this; }
;
async endControllers() {
await this.message.reactions.removeAll();
this.controllers.collector.stop();
let fe = this.message.embeds[0];
fe.setDescription(`${fe.description}\n\n*This menu has ended, start a new one to interact with it!*`);
fe.setFooter(`${fe.footer.text} | Menu ended`, this.client.user.avatarURL());
await this.message.edit(fe);
return this;
}
;
async start(options) {
await this.setPage(options && options.startPage ? options.startPage : 0);
await this.setControllers(options && options.endTime ? options.endTime : 60, options && options.user ? options.user : 'any');
return this;
}
;
async stop() {
return await this.endControllers();
}
;
} }
exports.Pagination = Pagination; exports.Pagination = Pagination;

108
util/ts/pagination.ts
Unescape View File

@ -1,4 +1,4 @@
import {TextChannel, Message, MessageEmbed, Client} from 'discord.js'; import {TextChannel, Message, MessageEmbed, Client, MessageReaction, ReactionCollector} from 'discord.js';
export class Pagination { export class Pagination {
channel: TextChannel; channel: TextChannel;
@ -7,10 +7,12 @@ export class Pagination {
originalMessage: Message; originalMessage: Message;
currentPage: number; currentPage: number;
client: Client; client: Client;
loopPages: boolean = true;
controllers: ControllerData = {enabled: false, endTime: null, collector: null, lastInteraction: null};
constructor (channel: TextChannel, pages: MessageEmbed[], originalMessage: Message, client: Client, message?: Message) { constructor (channel: TextChannel, pages: MessageEmbed[], originalMessage: Message, client: Client, loopPages?: boolean, message?: Message) {
this.channel = channel; this.channel = channel;
this.pages = pages; this.pages = pages;
this.originalMessage = message; this.originalMessage = message;
@ -18,6 +20,7 @@ export class Pagination {
this.currentPage = 0; this.currentPage = 0;
if (message) {this.message = message;} if (message) {this.message = message;}
if (loopPages) {this.loopPages = loopPages;}
}; };
@ -32,7 +35,7 @@ export class Pagination {
else {this.message = tempm;} else {this.message = tempm;}
} }
await this.message.edit(this.pages[page] await this.message.edit('', this.pages[page]
.setFooter(`Natsuki | Page ${page + 1} of ${this.pages.length}`, this.client.user.avatarURL()) .setFooter(`Natsuki | Page ${page + 1} of ${this.pages.length}`, this.client.user.avatarURL())
.setTimestamp() .setTimestamp()
); );
@ -42,19 +45,33 @@ export class Pagination {
}; };
public async nextPage(): Promise<Pagination> { public async nextPage(): Promise<Pagination> {
await this.setPage(typeof this.currentPage === "number" ? this.currentPage + 1 == this.pages.length ? this.currentPage : this.currentPage + 1 : 0); await this.setPage(typeof this.currentPage === "number"
? this.currentPage + 1 == this.pages.length
? this.loopPages
? 0
: this.currentPage
: this.currentPage + 1
: 0
);
return this; return this;
}; };
public async prevPage(): Promise<Pagination> { public async prevPage(): Promise<Pagination> {
await this.setPage(typeof this.currentPage === "number" ? this.currentPage === 0 ? 0 : this.currentPage - 1 : this.pages.length - 1); await this.setPage(typeof this.currentPage === "number"
? this.currentPage === 0
? this.loopPages
? this.pages.length - 1
: 0
: this.currentPage - 1
: this.pages.length - 1
);
return this; return this;
}; };
public addPage(page: MessageEmbed): Pagination { public addPage(page: MessageEmbed): Pagination {
this.pages.push(page); this.pages.push(page);
return this; return this;
} };
public replacePage(index: number, page: MessageEmbed): Pagination { public replacePage(index: number, page: MessageEmbed): Pagination {
if (index < 0) {throw new RangeError("replacePage() param 'index' must be a value greater than 0");} if (index < 0) {throw new RangeError("replacePage() param 'index' must be a value greater than 0");}
@ -62,5 +79,82 @@ export class Pagination {
this.pages[index] = page; this.pages[index] = page;
return this; return this;
} };
public async setControllers(endTime: number, user?: 'any' | string, extraControls?: ExtraControls): Promise<Pagination> {
if (this.controllers.enabled) {return;}
await this.message.react('⬅');
await this.message.react('➡');
await this.message.react('⏹');
let emoji = ['⬅', '➡', '⏹'];
let filter = user && user.toLowerCase().trim() !== 'any'
? (r: MessageReaction, u) => {return u.id === user.trim() && emoji.includes(r.emoji.name);}
: (r: MessageReaction) => {return emoji.includes(r.emoji.name);};
this.controllers.collector = this.message.createReactionCollector(filter, {time: 450000});
this.controllers.collector.on('collect', async (r: MessageReaction) => {
console.log(r);
let functions = {
'⬅': () => {return this.prevPage();},
'➡': () => {return this.nextPage();},
'⏹': () => {return this.endControllers();}
}
this.controllers.lastInteraction = new Date();
return functions[r.emoji.name]();
});
this.controllers.enabled = true;
this.controllers.endTime = endTime;
this.controllers.lastInteraction = new Date();
setInterval(() => {
if (new Date().getTime() - this.controllers.lastInteraction.getTime() > this.controllers.endTime && this.controllers.enabled) {return this.endControllers();}
}, this.controllers.endTime);
return this;
};
public async updateControllers(): Promise<Pagination> {return this;};
public async endControllers(): Promise<Pagination> {
await this.message.reactions.removeAll();
this.controllers.collector.stop();
let fe = this.message.embeds[0];
fe.setDescription(`${fe.description}\n\n*This menu has ended, start a new one to interact with it!*`);
fe.setFooter(`${fe.footer.text} | Menu ended`, this.client.user.avatarURL());
await this.message.edit(fe);
return this;
};
public async start(options?: {endTime?: number, startPage?: number, user?: 'any' | string}): Promise<Pagination> {
await this.setPage(options && options.startPage ? options.startPage : 0);
await this.setControllers(options && options.endTime ? options.endTime : 60, options && options.user ? options.user : 'any');
return this;
};
public async stop(): Promise<Pagination> {
return await this.endControllers();
};
}
interface ExtraControls {
}
interface ControllerData {
endTime: number,
enabled: boolean,
lastInteraction: Date,
collector: ReactionCollector
} }
Write Preview
Loading…
Cancel
Save