1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
|
import {
Arg,
BushConstants,
Global,
GlobalCache,
type BushClient,
type BushInspectOptions,
type BushMessage,
type BushNewsChannel,
type BushSlashEditMessageType,
type BushSlashMessage,
type BushSlashSendMessageType,
type BushTextChannel,
type BushUser,
type BushUserResolvable,
type CodeBlockLang,
type Pronoun,
type PronounCode
} from '#lib';
import { humanizeDuration } from '@notenoughupdates/humanize-duration';
import { exec } from 'child_process';
import deepLock from 'deep-lock';
import { ClientUtil, Util as AkairoUtil } from 'discord-akairo';
import { APIMessage } from 'discord-api-types';
import {
Constants as DiscordConstants,
GuildMember,
Message,
MessageEmbed,
ThreadMember,
User,
Util as DiscordUtil,
type ColorResolvable,
type CommandInteraction,
type InteractionReplyOptions,
type PermissionResolvable,
type Snowflake,
type TextChannel,
type UserResolvable
} from 'discord.js';
import got from 'got';
import _ from 'lodash';
import { inspect, promisify } from 'util';
import CommandErrorListener from '../../../listeners/commands/commandError.js';
import { Format } from '../../common/Format.js';
export class BushClientUtil extends ClientUtil {
/**
* The client.
*/
public declare readonly client: BushClient;
/**
* The hastebin urls used to post to hastebin, attempts to post in order
*/
#hasteURLs: string[] = [
'https://hst.sh',
// 'https://hasteb.in',
'https://hastebin.com',
'https://mystb.in',
'https://haste.clicksminuteper.net',
'https://paste.pythondiscord.com',
'https://haste.unbelievaboat.com'
// 'https://haste.tyman.tech'
];
/**
* Creates this client util
* @param client The client to initialize with
*/
public constructor(client: BushClient) {
super(client);
}
/**
* Maps an array of user ids to user objects.
* @param ids The list of IDs to map
* @returns The list of users mapped
*/
public async mapIDs(ids: Snowflake[]): Promise<User[]> {
return await Promise.all(ids.map((id) => client.users.fetch(id)));
}
/**
* Capitalizes the first letter of the given text
* @param text The text to capitalize
* @returns The capitalized text
*/
public capitalize(text: string): string {
return text.charAt(0).toUpperCase() + text.slice(1);
}
/**
* Runs a shell command and gives the output
* @param command The shell command to run
* @returns The stdout and stderr of the shell command
*/
public async shell(command: string): Promise<{
stdout: string;
stderr: string;
}> {
return await promisify(exec)(command);
}
/**
* Posts text to hastebin
* @param content The text to post
* @returns The url of the posted text
*/
public async haste(content: string, substr = false): Promise<HasteResults> {
let isSubstr = false;
if (content.length > 400_000 && !substr) {
void this.handleError('haste', new Error(`content over 400,000 characters (${content.length.toLocaleString()})`));
return { error: 'content too long' };
} else if (content.length > 400_000) {
content = content.substring(0, 400_000);
isSubstr = true;
}
for (const url of this.#hasteURLs) {
try {
const res: HastebinRes = await got.post(`${url}/documents`, { body: content }).json();
return { url: `${url}/${res.key}`, error: isSubstr ? 'substr' : undefined };
} catch {
void client.console.error('haste', `Unable to upload haste to ${url}`);
}
}
return { error: 'unable to post' };
}
/**
* Resolves a user-provided string into a user object, if possible
* @param text The text to try and resolve
* @returns The user resolved or null
*/
public async resolveUserAsync(text: string): Promise<User | null> {
const idReg = /\d{17,19}/;
const idMatch = text.match(idReg);
if (idMatch) {
try {
return await client.users.fetch(text as Snowflake);
} catch {
// pass
}
}
const mentionReg = /<@!?(?<id>\d{17,19})>/;
const mentionMatch = text.match(mentionReg);
if (mentionMatch) {
try {
return await client.users.fetch(mentionMatch.groups!.id as Snowflake);
} catch {
// pass
}
}
const user = client.users.cache.find((u) => u.username === text);
if (user) return user;
return null;
}
/**
* Appends the correct ordinal to the given number
* @param n The number to append an ordinal to
* @returns The number with the ordinal
*/
public ordinal(n: number): string {
const s = ['th', 'st', 'nd', 'rd'],
v = n % 100;
return n + (s[(v - 20) % 10] || s[v] || s[0]);
}
/**
* Chunks an array to the specified size
* @param arr The array to chunk
* @param perChunk The amount of items per chunk
* @returns The chunked array
*/
public chunk<T>(arr: T[], perChunk: number): T[][] {
return arr.reduce((all, one, i) => {
const ch: number = Math.floor(i / perChunk);
(all as any[])[ch] = [].concat(all[ch] || [], one as any);
return all;
}, []);
}
/**
* Commonly Used Colors
*/
get colors() {
return client.consts.colors;
}
/**
* Commonly Used Emojis
*/
get emojis() {
return client.consts.emojis;
}
/**
* A simple utility to create and embed with the needed style for the bot.
* @param color The color to set the embed to.
* @param author The author to set the embed to.
* @returns The generated embed.
*/
public createEmbed(color?: ColorResolvable, author?: User | GuildMember): MessageEmbed {
if (author instanceof GuildMember) {
author = author.user; // Convert to User if GuildMember
}
let embed = new MessageEmbed().setTimestamp();
if (author)
embed = embed.setAuthor({
name: author.username,
iconURL: author.displayAvatarURL({ dynamic: true }),
url: `https://discord.com/users/${author.id}`
});
if (color) embed = embed.setColor(color);
return embed;
}
/**
* Fetches a user's uuid from the mojang api.
* @param username The username to get the uuid of.
* @returns The the uuid of the user.
*/
public async mcUUID(username: string, dashed = false): Promise<string> {
const apiRes = (await got.get(`https://api.ashcon.app/mojang/v2/user/${username}`).json()) as UuidRes;
return dashed ? apiRes.uuid : apiRes.uuid.replace(/-/g, '');
}
/**
* Surrounds text in a code block with the specified language and puts it in a hastebin if its too long.
* * Embed Description Limit = 4096 characters
* * Embed Field Limit = 1024 characters
* @param code The content of the code block.
* @param length The maximum length of the code block.
* @param language The language of the code.
* @param substr Whether or not to substring the code if it is too long.
* @returns The generated code block
*/
public async codeblock(code: string, length: number, language: CodeBlockLang | '' = '', substr = false): Promise<string> {
let hasteOut = '';
code = this.discord.escapeCodeBlock(code);
const prefix = `\`\`\`${language}\n`;
const suffix = '\n```';
if (code.length + (prefix + suffix).length >= length) {
const haste = await this.haste(code, substr);
hasteOut = `Too large to display. ${
haste.url
? `Hastebin: ${haste.url}${haste.error ? ` - ${haste.error}` : ''}`
: `${this.emojis.error} Hastebin: ${haste.error}`
}`;
}
const FormattedHaste = hasteOut.length ? `\n${hasteOut}` : '';
const shortenedCode = hasteOut ? code.substring(0, length - (prefix + FormattedHaste + suffix).length) : code;
const code3 = code.length ? prefix + shortenedCode + suffix + FormattedHaste : prefix + suffix;
if (code3.length > length) {
void client.console.warn(`codeblockError`, `Required Length: ${length}. Actual Length: ${code3.length}`, true);
void client.console.warn(`codeblockError`, code3, true);
throw new Error('code too long');
}
return code3;
}
/**
* Uses {@link inspect} with custom defaults.
* @param object - The object you would like to inspect.
* @param options - The options you would like to use to inspect the object.
* @returns The inspected object.
*/
public inspect(object: any, options?: BushInspectOptions): string {
const optionsWithDefaults = this.getDefaultInspectOptions(options);
return inspect(object, optionsWithDefaults);
}
/**
* Generate defaults for {@link inspect}.
* @param options The options to create defaults with.
* @returns The default options combined with the specified options.
*/
private getDefaultInspectOptions(options?: BushInspectOptions): BushInspectOptions {
const {
showHidden = false,
depth = 2,
colors = false,
customInspect = true,
showProxy = false,
maxArrayLength = Infinity,
maxStringLength = Infinity,
breakLength = 80,
compact = 3,
sorted = false,
getters = true
} = options ?? {};
return {
showHidden,
depth,
colors,
customInspect,
showProxy,
maxArrayLength,
maxStringLength,
breakLength,
compact,
sorted,
getters
};
}
/**
* Maps the key of a credential with a readable version when redacting.
* @param key The key of the credential.
* @returns The readable version of the key or the original key if there isn't a mapping.
*/
#mapCredential(key: string): string {
const mapping = {
token: 'Main Token',
devToken: 'Dev Token',
betaToken: 'Beta Token',
hypixelApiKey: 'Hypixel Api Key',
wolframAlphaAppId: 'Wolfram|Alpha App ID',
dbPassword: 'Database Password'
};
return mapping[key as keyof typeof mapping] || key;
}
/**
* Redacts credentials from a string.
* @param text The text to redact credentials from.
* @returns The redacted text.
*/
public redact(text: string) {
for (const credentialName in { ...client.config.credentials, dbPassword: client.config.db.password }) {
const credential = { ...client.config.credentials, dbPassword: client.config.db.password }[
credentialName as keyof typeof client.config.credentials
];
const replacement = this.#mapCredential(credentialName);
const escapeRegex = /[.*+?^${}()|[\]\\]/g;
text = text.replace(new RegExp(credential.toString().replace(escapeRegex, '\\$&'), 'g'), `[${replacement} Omitted]`);
text = text.replace(
new RegExp([...credential.toString()].reverse().join('').replace(escapeRegex, '\\$&'), 'g'),
`[${replacement} Omitted]`
);
}
return text;
}
/**
* Takes an any value, inspects it, redacts credentials, and puts it in a codeblock
* (and uploads to hast if the content is too long).
* @param input The object to be inspect, redacted, and put into a codeblock.
* @param language The language to make the codeblock.
* @param inspectOptions The options for {@link BushClientUtil.inspect}.
* @param length The maximum length that the codeblock can be.
* @returns The generated codeblock.
*/
public async inspectCleanRedactCodeblock(
input: any,
language?: CodeBlockLang | '',
inspectOptions?: BushInspectOptions & { inspectStrings?: boolean },
length = 1024
) {
input =
!inspectOptions?.inspectStrings && typeof input === 'string' ? input : this.inspect(input, inspectOptions ?? undefined);
if (inspectOptions) inspectOptions.inspectStrings = undefined;
input = this.discord.cleanCodeBlockContent(input);
input = this.redact(input);
return this.codeblock(input, length, language, true);
}
/**
* Takes an any value, inspects it, redacts credentials, and uploads it to haste.
* @param input The object to be inspect, redacted, and upload.
* @param inspectOptions The options for {@link BushClientUtil.inspect}.
* @returns The {@link HasteResults}.
*/
public async inspectCleanRedactHaste(input: any, inspectOptions?: BushInspectOptions): Promise<HasteResults> {
input = typeof input !== 'string' ? this.inspect(input, inspectOptions ?? undefined) : input;
input = this.redact(input);
return this.haste(input, true);
}
/**
* Takes an any value, inspects it and redacts credentials.
* @param input The object to be inspect and redacted.
* @param inspectOptions The options for {@link BushClientUtil.inspect}.
* @returns The redacted and inspected object.
*/
public inspectAndRedact(input: any, inspectOptions?: BushInspectOptions): string {
input = typeof input !== 'string' ? this.inspect(input, inspectOptions ?? undefined) : input;
return this.redact(input);
}
/**
* Responds to a slash command interaction.
* @param interaction The interaction to respond to.
* @param responseOptions The options for the response.
* @returns The message sent.
*/
public async slashRespond(
interaction: CommandInteraction,
responseOptions: BushSlashSendMessageType | BushSlashEditMessageType
): Promise<Message | APIMessage | undefined> {
const newResponseOptions = typeof responseOptions === 'string' ? { content: responseOptions } : responseOptions;
if (interaction.replied || interaction.deferred) {
delete (newResponseOptions as InteractionReplyOptions).ephemeral; // Cannot change a preexisting message to be ephemeral
return (await interaction.editReply(newResponseOptions)) as Message | APIMessage;
} else {
await interaction.reply(newResponseOptions);
return await interaction.fetchReply().catch(() => undefined);
}
}
/**
* Gets a a configured channel as a TextChannel.
* @channel The channel to retrieve.
*/
public async getConfigChannel(channel: keyof typeof client['config']['channels']): Promise<TextChannel> {
return (await client.channels.fetch(client.config.channels[channel])) as unknown as TextChannel;
}
/**
* Takes an array and combines the elements using the supplied conjunction.
* @param array The array to combine.
* @param conjunction The conjunction to use.
* @param ifEmpty What to return if the array is empty.
* @returns The combined elements or `ifEmpty`.
*
* @example
* const permissions = oxford(['ADMINISTRATOR', 'SEND_MESSAGES', 'MANAGE_MESSAGES'], 'and', 'none');
* console.log(permissions); // ADMINISTRATOR, SEND_MESSAGES and MANAGE_MESSAGES
*/
public oxford(array: string[], conjunction: string, ifEmpty?: string): string | undefined {
const l = array.length;
if (!l) return ifEmpty;
if (l < 2) return array[0];
if (l < 3) return array.join(` ${conjunction} `);
array = array.slice();
array[l - 1] = `${conjunction} ${array[l - 1]}`;
return array.join(', ');
}
public getGlobal(): GlobalCache;
public getGlobal<K extends keyof GlobalCache>(key: K): GlobalCache[K];
public getGlobal(key?: keyof GlobalCache) {
return key ? client.cache.global[key] : client.cache.global;
}
/**
* Add or remove an element from an array stored in the Globals database.
* @param action Either `add` or `remove` an element.
* @param key The key of the element in the global cache to update.
* @param value The value to add/remove from the array.
*/
public async insertOrRemoveFromGlobal<K extends keyof typeof client['cache']['global']>(
action: 'add' | 'remove',
key: K,
value: typeof client['cache']['global'][K][0]
): Promise<Global | void> {
const row =
(await Global.findByPk(client.config.environment)) ?? (await Global.create({ environment: client.config.environment }));
const oldValue: any[] = row[key];
const newValue = this.addOrRemoveFromArray(action, oldValue, value);
row[key] = newValue;
client.cache.global[key] = newValue;
return await row.save().catch((e) => this.handleError('insertOrRemoveFromGlobal', e));
}
/**
* Updates an element in the Globals database.
* @param key The key in the global cache to update.
* @param value The value to set the key to.
*/
public async setGlobal<K extends keyof typeof client['cache']['global']>(
key: K,
value: typeof client['cache']['global'][K]
): Promise<Global | void> {
const row =
(await Global.findByPk(client.config.environment)) ?? (await Global.create({ environment: client.config.environment }));
row[key] = value;
client.cache.global[key] = value;
return await row.save().catch((e) => this.handleError('setGlobal', e));
}
/**
* Add or remove an item from an array. All duplicates will be removed.
* @param action Either `add` or `remove` an element.
* @param array The array to add/remove an element from.
* @param value The element to add/remove from the array.
*/
public addOrRemoveFromArray<T>(action: 'add' | 'remove', array: T[], value: T): T[] {
const set = new Set(array);
action === 'add' ? set.add(value) : set.delete(value);
return [...set];
}
/**
* Surrounds a string to the begging an end of each element in an array.
* @param array The array you want to surround.
* @param surroundChar1 The character placed in the beginning of the element.
* @param surroundChar2 The character placed in the end of the element. Defaults to `surroundChar1`.
*/
public surroundArray(array: string[], surroundChar1: string, surroundChar2?: string): string[] {
return array.map((a) => `${surroundChar1}${a}${surroundChar2 ?? surroundChar1}`);
}
/**
* Gets the duration from a specified string.
* @param content The string to look for a duration in.
* @param remove Whether or not to remove the duration from the original string.
* @returns The {@link ParsedDuration}.
*/
public parseDuration(content: string, remove = true): ParsedDuration {
if (!content) return { duration: 0, contentWithoutTime: null };
// eslint-disable-next-line prefer-const
let duration = null;
// Try to reduce false positives by requiring a space before the duration, this makes sure it still matches if it is
// in the beginning of the argument
let contentWithoutTime = ` ${content}`;
for (const unit in BushConstants.TimeUnits) {
const regex = BushConstants.TimeUnits[unit as keyof typeof BushConstants.TimeUnits].match;
const match = regex.exec(contentWithoutTime);
const value = Number(match?.groups?.[unit]);
if (!isNaN(value))
(duration as unknown as number) += value * BushConstants.TimeUnits[unit as keyof typeof BushConstants.TimeUnits].value;
if (remove) contentWithoutTime = contentWithoutTime.replace(regex, '');
}
// remove the space added earlier
if (contentWithoutTime.startsWith(' ')) contentWithoutTime.replace(' ', '');
return { duration, contentWithoutTime };
}
/**
* Converts a duration in milliseconds to a human readable form.
* @param duration The duration in milliseconds to convert.
* @param largest The maximum number of units to display for the duration.
* @returns A humanized string of the duration.
*/
public humanizeDuration(duration: number, largest?: number): string {
if (largest) return humanizeDuration(duration, { language: 'en', maxDecimalPoints: 2, largest })!;
else return humanizeDuration(duration, { language: 'en', maxDecimalPoints: 2 })!;
}
/**
* Creates a formatted relative timestamp from a duration in milliseconds.
* @param duration The duration in milliseconds.
* @returns The formatted relative timestamp.
*/
public timestampDuration(duration: number): string {
return `<t:${Math.round(new Date().getTime() / 1_000 + duration / 1_000)}:R>`;
}
/**
* Creates a timestamp from a date.
* @param date The date to create a timestamp from.
* @param style The style of the timestamp.
* @returns The formatted timestamp.
*
* @see
* **Styles:**
* - **t**: Short Time
* - **T**: Long Time
* - **d**: Short Date
* - **D**: Long Date
* - **f**: Short Date/Time
* - **F**: Long Date/Time
* - **R**: Relative Time
*/
public timestamp<D extends Date | undefined | null>(
date: D,
style: 't' | 'T' | 'd' | 'D' | 'f' | 'F' | 'R' = 'f'
): D extends Date ? string : undefined {
if (!date) return date as unknown as D extends Date ? string : undefined;
return `<t:${Math.round(date.getTime() / 1_000)}:${style}>` as unknown as D extends Date ? string : undefined;
}
/**
* Creates a human readable representation between a date and the current time.
* @param date The date to be compared with the current time.
* @param largest The maximum number of units to display for the duration.
* @returns A humanized string of the delta.
*/
public dateDelta(date: Date, largest?: number): string {
return this.humanizeDuration(new Date().getTime() - date.getTime(), largest ?? 3);
}
/**
* Convert a hex code to an rbg value.
* @param hex The hex code to convert.
* @returns The rbg value.
*/
public hexToRgb(hex: string): string {
const arrBuff = new ArrayBuffer(4);
const vw = new DataView(arrBuff);
vw.setUint32(0, parseInt(hex, 16), false);
const arrByte = new Uint8Array(arrBuff);
return `${arrByte[1]}, ${arrByte[2]}, ${arrByte[3]}`;
}
/* eslint-disable @typescript-eslint/no-unused-vars */
public async lockdownChannel(options: { channel: BushTextChannel | BushNewsChannel; moderator: BushUserResolvable }) {
// todo: implement lockdowns
}
/* eslint-enable @typescript-eslint/no-unused-vars */
/**
* Capitalize the first letter of a string.
* @param string The string to capitalize the first letter of.
* @returns The string with the first letter capitalized.
*/
public capitalizeFirstLetter(string: string): string {
return string.charAt(0)?.toUpperCase() + string.slice(1);
}
/**
* Wait an amount in seconds.
* @param seconds The number of seconds to wait
* @returns A promise that resolves after the specified amount of seconds
*/
public async sleep(seconds: number) {
return new Promise((resolve) => setTimeout(resolve, seconds * 1000));
}
/**
* Send a message in the error logging channel and console for an error.
* @param context
* @param error
*/
public async handleError(context: string, error: Error) {
await client.console.error(_.camelCase(context), `An error occurred:\n${error?.stack ?? (error as any)}`, false);
await client.console.channelError({
embeds: [await CommandErrorListener.generateErrorEmbed({ type: 'unhandledRejection', error: error, context })]
});
}
/**
* Fetches a user from discord.
* @param user The user to fetch
* @returns Undefined if the user is not found, otherwise the user.
*/
public async resolveNonCachedUser(user: UserResolvable | undefined | null): Promise<BushUser | undefined> {
if (user == null) return undefined;
const id =
user instanceof User || user instanceof GuildMember || user instanceof ThreadMember
? user.id
: user instanceof Message
? user.author.id
: typeof user === 'string'
? user
: undefined;
if (!id) return undefined;
else return await client.users.fetch(id).catch(() => undefined);
}
/**
* Get the pronouns of a discord user from pronoundb.org
* @param user The user to retrieve the promises of.
* @returns The human readable pronouns of the user, or undefined if they do not have any.
*/
public async getPronounsOf(user: User | Snowflake): Promise<Pronoun | undefined> {
const _user = await this.resolveNonCachedUser(user);
if (!_user) throw new Error(`Cannot find user ${user}`);
const apiRes = (await got
.get(`https://pronoundb.org/api/v1/lookup?platform=discord&id=${_user.id}`)
.json()
.catch(() => undefined)) as { pronouns: PronounCode } | undefined;
if (!apiRes) return undefined;
if (!apiRes.pronouns) throw new Error('apiRes.pronouns is undefined');
return client.constants.pronounMapping[apiRes.pronouns!]!;
}
/**
* List the methods of an object.
* @param obj The object to get the methods of.
* @returns A string with each method on a new line.
*/
public getMethods(obj: Record<string, any>): string {
// modified from https://stackoverflow.com/questions/31054910/get-functions-methods-of-a-class
// answer by Bruno Grieder
let props: string[] = [];
let obj_: Record<string, any> = new Object(obj);
do {
const l = Object.getOwnPropertyNames(obj_)
.concat(Object.getOwnPropertySymbols(obj_).map((s) => s.toString()))
.sort()
.filter(
(p, i, arr) =>
typeof Object.getOwnPropertyDescriptor(obj_, p)?.['get'] !== 'function' && // ignore getters
typeof Object.getOwnPropertyDescriptor(obj_, p)?.['set'] !== 'function' && // ignore setters
typeof obj_[p] === 'function' && //only the methods
p !== 'constructor' && //not the constructor
(i == 0 || p !== arr[i - 1]) && //not overriding in this prototype
props.indexOf(p) === -1 //not overridden in a child
);
const reg = /\(([\s\S]*?)\)/;
props = props.concat(
l.map(
(p) =>
`${obj_[p] && obj_[p][Symbol.toStringTag] === 'AsyncFunction' ? 'async ' : ''}function ${p}(${
reg.exec(obj_[p].toString())?.[1]
? reg
.exec(obj_[p].toString())?.[1]
.split(', ')
.map((arg) => arg.split('=')[0].trim())
.join(', ')
: ''
});`
)
);
} while (
(obj_ = Object.getPrototypeOf(obj_)) && //walk-up the prototype chain
Object.getPrototypeOf(obj_) //not the the Object prototype methods (hasOwnProperty, etc...)
);
return props.join('\n');
}
/**
* Uploads an image to imgur.
* @param image The image to upload.
* @returns The url of the imgur.
*/
public async uploadImageToImgur(image: string) {
const clientId = this.client.config.credentials.imgurClientId;
const resp = (await got
.post('https://api.imgur.com/3/upload', {
headers: {
Authorization: `Client-ID ${clientId}`,
Accept: 'application/json'
},
form: {
image: image,
type: 'base64'
},
followRedirect: true
})
.json()) as { data: { link: string } };
return resp.data.link;
}
/**
* Checks if a user has a certain guild permission (doesn't check channel permissions).
* @param message The message to check the user from.
* @param permissions The permissions to check for.
* @returns The missing permissions or null if none are missing.
*/
public userGuildPermCheck(message: BushMessage | BushSlashMessage, permissions: PermissionResolvable) {
const missing = message.member?.permissions.missing(permissions) ?? [];
return missing.length ? missing : null;
}
/**
* Check if the client has certain permissions in the guild (doesn't check channel permissions).
* @param message The message to check the client user from.
* @param permissions The permissions to check for.
* @returns The missing permissions or null if none are missing.
*/
public clientGuildPermCheck(message: BushMessage | BushSlashMessage, permissions: PermissionResolvable) {
const missing = message.guild?.me?.permissions.missing(permissions) ?? [];
return missing.length ? missing : null;
}
/**
* Check if the client has permission to send messages in the channel as well as check if they have other permissions
* in the guild (or the channel if `checkChannel` is `true`).
* @param message The message to check the client user from.
* @param permissions The permissions to check for.
* @param checkChannel Whether to check the channel permissions instead of the guild permissions.
* @returns The missing permissions or null if none are missing.
*/
public clientSendAndPermCheck(
message: BushMessage | BushSlashMessage,
permissions: PermissionResolvable = [],
checkChannel = false
) {
const missing = [];
const sendPerm = message.channel!.isThread() ? 'SEND_MESSAGES' : 'SEND_MESSAGES_IN_THREADS';
if (!message.guild!.me!.permissionsIn(message.channel!.id!).has(sendPerm)) missing.push(sendPerm);
missing.push(
...(checkChannel
? message.guild!.me!.permissionsIn(message.channel!.id!).missing(permissions)
: this.clientGuildPermCheck(message, permissions) ?? [])
);
return missing.length ? missing : null;
}
/**
* Gets the prefix based off of the message.
* @param message The message to get the prefix from.
* @returns The prefix.
*/
public prefix(message: BushMessage | BushSlashMessage): string {
return message.util.isSlash
? '/'
: client.config.isDevelopment
? 'dev '
: message.util.parsed?.prefix ?? client.config.prefix;
}
/**
* Recursively apply provided options operations on object
* and all of the object properties that are either object or function.
*
* By default freezes object.
*
* @param obj - The object to which will be applied `freeze`, `seal` or `preventExtensions`
* @param options default `{ action: 'freeze' }`
* @param options.action
* ```
* | action | Add | Modify | Delete | Reconfigure |
* | ----------------- | --- | ------ | ------ | ----------- |
* | preventExtensions | - | + | + | + |
* | seal | - | + | - | - |
* | freeze | - | - | - | - |
* ```
*
* @returns Initial object with applied options action
*/
public get deepFreeze() {
return deepLock;
}
/**
* Recursively apply provided options operations on object
* and all of the object properties that are either object or function.
*
* By default freezes object.
*
* @param obj - The object to which will be applied `freeze`, `seal` or `preventExtensions`
* @param options default `{ action: 'freeze' }`
* @param options.action
* ```
* | action | Add | Modify | Delete | Reconfigure |
* | ----------------- | --- | ------ | ------ | ----------- |
* | preventExtensions | - | + | + | + |
* | seal | - | + | - | - |
* | freeze | - | - | - | - |
* ```
*
* @returns Initial object with applied options action
*/
public static get deepFreeze() {
return deepLock;
}
/**
* A wrapper for the Argument class that adds custom typings.
*/
public get arg() {
return Arg;
}
/**
* Formats and escapes content for formatting
*/
public get format() {
return Format;
}
/**
* Discord.js's Util class
*/
public get discord() {
return DiscordUtil;
}
/**
* Discord.js's Util constants
*/
public get discordConstants() {
return DiscordConstants;
}
/**
* discord-akairo's Util class
*/
public get akairo() {
return AkairoUtil;
}
}
interface HastebinRes {
key: string;
}
export interface UuidRes {
uuid: string;
username: string;
username_history?: { username: string }[] | null;
textures: {
custom: boolean;
slim: boolean;
skin: {
url: string;
data: string;
};
raw: {
value: string;
signature: string;
};
};
created_at: string;
}
export interface HasteResults {
url?: string;
error?: 'content too long' | 'substr' | 'unable to post';
}
export interface ParsedDuration {
duration: number | null;
contentWithoutTime: string | null;
}
|