-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
727 lines (608 loc) · 22.6 KB
/
index.d.ts
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
import Eris from '@augu/eris';
import { Collection } from '@maika.xyz/eris-utils';
import Hideri from '@maika.xyz/hideri';
/** The heart and soul of Maika. */
declare namespace Kotori {
/**
* The version of the component: `@maika.xyz/kotori`
*/
export const version: string;
/**
* Create a new instance of Kotori
*
* The `create` function is here so you can use `Kotori.create()` to return the `Client` instance but you can still do `new KotoriClient()`.
* @param options The additional options to create the client
* @returns The client instance
*/
export function create(options: Kotori.DefaultOptions): Kotori.Client;
// #region Classes
/** The argument parser */
export class ArgumentParser {
public arguments: string[];
/**
* Create a new instance of the argument parser
* @param arguments The arguments to construct
*/
constructor(arguments: string[]);
/**
* Gets the argument string
* @param index The index number to get
* @returns The argument string
*/
public get(index: number): string;
/**
* Checks if the index of the argument is empty
* @param index The index number to check
* @returns A boolean if it is or not
*/
public isEmpty(index: number): boolean;
/**
* Gathers the arguments
* @param sep The seperator to seperate it (default: `' '`)
* @returns The gathered arguments
*/
public gather(sep?: string): string;
/**
* Removes the first element and returns the argument(s)
* @returns The arguments but the first element removed
*/
public shift(): string[];
/**
* Checks the length of `index` if anything is assoiated
* with it
* @param index The index
* @returns a Boolean if it is or not
*/
public has(index: number): boolean;
}
/** The client to initisate from */
export class Client extends Eris.Client {
public manager: CommandManager;
public events: EventManager;
public schedulers: SchedulerManager;
public database: DatabaseManager;
public emojis: { [x: string]: string; };
public logger: Hideri.Logger;
public prefix: string;
public owners: string[];
/**
* Construct a new Client instance
* @param options Addition options to add on to
*/
constructor(options: Kotori.DefaultOptions);
/**
* Boots the bot up
*/
public start(): Promise<void>;
/**
* Grabs a shard ID
* @param i The shard ID
* @returns The shard
*/
public getShard(i: number): Eris.Shard;
}
/** The command interface */
export class Command {
public client: Kotori.Client;
public command: string;
public description: string | Kotori.DescriptionSupplier;
public usage: string;
public category: string;
public aliases: string[];
public hidden: boolean;
public disabled: boolean;
public ownerOnly: boolean;
public guildOnly: boolean;
public nsfw: boolean;
public throttle: number;
/**
* Construct a new instance of the Command interface
* @param client The client
* @param options Additional options to add on
*/
constructor(client: Kotori.Client, options: Kotori.CommandOptions);
/**
* Prettifies the command usage
*/
public format(ctx: Kotori.CommandContext): string;
/**
* Unloads the command
*/
public unload(): void;
}
/** The command context */
export class CommandContext {
public client: Kotori.Client;
public message: Eris.Message;
public args: Kotori.ArgumentParser;
public collector: Kotori.MessageCollector;
public guildSettings: Kotori.GuildSettings;
public userSettings: Kotori.UserSettings;
public guild: Eris.Guild;
public channel: Eris.TextableChannel;
public sender: Eris.User;
/**
* Create a new instance of the command context interface
* @param client The client
* @param message The message
* @param args The array of arguments provided
*/
constructor(client: Kotori.Client, message: Eris.Message, args: string[]);
/**
* Sends a message to the text channel
* @param content The content to send
* @returns The promised message that was sent
*/
public send(content: string): Promise<Eris.Message>;
/**
* Sends an embed to the text channel
* @param content The embed to send
* @returns The promised message that was sent
*/
public embed(content: Eris.Embed): Promise<Eris.Message>;
/**
* Translates the user's locale into a string
* @param term The term to get
* @param args Any additional contextial arguments to add
* @returns The locale translated
*/
public translate(term: string, ...args: any[]): Promise<string>;
/**
* Sends a codeblock to a Discord channel
* @param lang The language
* @param content The content to send
* @returns The promised message
*/
public code(lang: string, content: string): Promise<Eris.Message>;
/**
* Shoots a message to a Discord user's DM channel
* @param content The content to send
* @param options Contextial options to add on
* @returns The promised message
*/
public dm(content: string, options?: {
user: Eris.User;
embed?: Eris.Embed;
}): Promise<Eris.Message>;
}
/** The command manager to manage "command" related stuff */
export class CommandManager implements Manager {
public client: Kotori.Client;
public commands: Collection<Command>;
public processor: CommandProcessor;
public options: Kotori.ManagerOptions;
/**
* Construct a new instance of the Command manager
* @param client The client
* @param options The options
*/
constructor(client: Kotori.Client, options: Kotori.ManagerOptions);
public start(): void;
}
/** The command processor to process all commands */
export class CommandProcessor implements Processor {
public client: Kotori.Client;
public ratelimits: Collection<Collection<number>>;
/**
* Construct a new command processor
* @param client The client
*/
constructor(client: Kotori.Client);
public process(msg: Eris.Message): void;
}
/** The database manager */
export class DatabaseManager {
public client: Kotori.Client;
public m: typeof import("mongoose");
/**
* Construct a new database manager interface
* @param client The client
* @param options The options to add on to
*/
constructor(client: Kotori.Client, options: Kotori.DatabaseManagerOptions);
/**
* Starts the database
*/
public connect(): Promise<void>;
/**
* Destroys the database
* @param reason The reason (default: `Killed Process CTRL+Q`)
* @returns The trace result
*/
public destroy(reason?: string): Kotori.IDestroyResult;
}
/** The event interface */
export class Event {
public client: Kotori.Client;
public event: Kotori.Emittable;
/**
* Construct a new event interface
* @param client The client
* @param event The event to run
*/
constructor(client: Kotori.Client, event: Kotori.Emittable);
/**
* Runs the event
* @param args Any arguments to run
*/
public emit(...args: any[]): void;
}
/** The event manager to manage all "event" releated stuff */
export class EventManager implements Manager {
public client: Kotori.Client;
/**
* Construct a new event manager
* @param client The client instance
* @param options The options to add on to
*/
constructor(client: Kotori.Client, options: Kotori.ManagerOptions);
public start(): void;
}
/** The event processor to process all events */
export class EventProcessor implements Processor {
public client: Kotori.Client;
/**
* Construct a new event processor
* @param client The client
*/
constructor(client: Kotori.Client);
public process(event: Kotori.Event): void;
}
/** Guild settings */
export class GuildSettings implements SettingsBase<IGuildSettings> {
public client: Kotori.Client;
public schema: IGuildSettings;
constructor(client: Kotori.Client);
public get(id: string): IGuildSettings;
public update(options: { id: string; doc: any; callback: (error: Error, data: IGuildSettings) => void; }): Promise<void>;
public delete(id: string): Promise<void>;
}
/** The manager interface */
export interface Manager {
/** The client */
client: Kotori.Client;
/** The start function to process the manager's doings */
start(): void;
}
/** The message collector for awaiting messages */
export class MessageCollector {
public collectors: {
[x: string]: {
filter: Kotori.MessageFilter;
accept: (value?: Promise<Eris.Message> | PromiseLike<Eris.Message>) => void;
}
};
/**
* Construct a new message collector instance
* @param client The client instance
*/
constructor(client: Kotori.Client);
/**
* Verifies an awaited message
* @param msg The message
*/
private verify(msg: Eris.Message): void;
/**
* Await an message
* @param filter The filter
* @param options Additional contextial options
* @returns The promised message
*/
public awaitMessage(filter: Kotori.MessageFilter, options: Kotori.MessageCollectorOptions): Promise<Eris.Message>;
}
/** Permission utils for Discord permissions */
export class PermissionUtil {
public prettified: { [x: string]: string; };
/**
* Resolves a permission bitfield
* @param permission The permission bitfield
* @returns The bitfield number
*/
public static resolve(permission: Kotori.PermissionResolvable): number;
/**
* Utility to check permission bitfields for users
* @param member The member
* @param permission The permission
* @returns If they have it or not
*/
public static hasPermission(member: Eris.Member, permission: Kotori.Permission): boolean;
/**
* Prettified permission bitfield
* @param permission The field
* @returns The prettified permission
*/
public static humanize(permission: Kotori.Permission): string;
}
/** Processor interface */
export interface Processor {
/** The client instance */
client: Kotori.Client;
/** Process the proccessor's proces */
process(...args: any[]): void;
}
/** The REST client to grab Discord objects */
export class RESTClient {
public client: Kotori.Client;
/**
* Construct a new instance of the REST client to grab Discord Objects
* @param client The client instance
*/
constructor(client: Kotori.Client);
/**
* Grabs a discord "role"
* @param query The query
* @param guild The guild
* @returns The promised role
*/
public getRole(query: string, guild: Eris.Guild): Promise<Eris.Role>;
/**
* Grabs a discord "user"
* @param query The query
* @returns The promised user
*/
public getUser(query: string): Promise<Eris.User>;
/**
* Grabs a discord text/voice/category channel
* @param query The query
* @param guild The guild
* @returns The promised channel
*/
public getChannel(query: string, guild: Eris.Guild): Promise<Eris.TextChannel | Eris.VoiceChannel | Eris.CategoryChannel>;
/**
* Grabs a discord guild
* @param query The query
* @returns The promised guild
*/
public getGuild(query: string): Promise<Eris.Guild>;
/**
* Gets a Discord message
* @param channelID The channel ID
* @param messageID The message ID
* @returns The promised message
*/
public getMessage(channelID: string, messageID: string): Promise<Eris.Message>;
}
/** Setting Base Interface */
export interface SettingsBase<U> {
client: Kotori.Client;
schema: U;
get(id: string): U;
update(options: {
id: string;
doc: any;
callback: (error: Error, data: U) => void;
}): Promise<void>;
delete(id: string): Promise<void>;
}
/** The scheduler interface */
export class Scheduler {
public client: Kotori.Client;
public name: string;
public interval: number;
public disabled: boolean;
/**
* Construct a new scheduler interface
* @param client The client
* @param options Additional contextial options
*/
constructor(client: Kotori.Client, options: Kotori.SchedulerOptions);
public run(): void;
}
/** The scheduler manager to manage all "task" related stuff */
export class SchedulerManager implements Manager {
public client: Kotori.Client;
public tasks: Collection<Kotori.Scheduler>;
/**
* Construct a new scheduler manager
* @param client The client
* @param options Additional contextial options
*/
constructor(client: Kotori.Client, options: Kotori.ManagerOptions);
public start(): void;
}
/** User settings */
export class UserSettings implements SettingsBase<IUserSettings> {
public client: Kotori.Client;
public schema: IUserSettings;
constructor(client: Kotori.Client);
public get(id: string): IUserSettings;
public update(options: { id: string; doc: any; callback: (error: Error, data: IUserSettings) => void; }): Promise<void>;
public delete(id: string): Promise<void>;
}
/** Other utilities */
export class Util {
/**
* Checks if `x` is a function
* @param fn The function
* @returns A boolean if it is or not
*/
public static isFunction(x: Function): boolean;
}
// #endregion Classes
// #region Types
/** Type definition for type: `ILavalinkTrack` */
export type ILavalinkTrack = {
/** The unique identifier of the track, as defined by the provider (youtube, soundcloud, etc..) */
identifier: string;
/** Whether the use of the seek method is possible */
isSeekable: boolean;
/** The name of the author of the track */
author: string;
/** The duration of the track in milliseconds */
length: number;
/** Whether the track is a livestream or not */
isStream: boolean;
/** The current position of the player in the track, represented in milliseconds */
position: number;
/** The title of the track */
title: string;
/** The URL of the track */
uri: string;
};
/** Type definition for type: `LavalinkTrack` */
export type LavalinkTrack = {
/** The base64 encoded track name */
name: string;
/** The track information */
track: Kotori.ILavalinkTrack;
}
/** Type definition for type: `DefaultOptions` */
export type DefaultOptions = {
/** The discord bot token to authenicate to Discord */
token: string;
/** The command prefix */
prefix: string;
/** The path to all of the commands */
commands: string;
/** Path to all events */
events: string;
/** Path to all tasks (schedulers) */
schedulers: string;
/** Path to all locales */
languages: string;
/** Lavalink options */
lavalink: LavalinkOptions;
/** MongoDB authenication */
dbURL: string;
/** The owners of the bot */
owners: string[];
} & Eris.ClientOptions;
/** Type definition for type: `LavalinkOptions` */
export type LavalinkOptions = {
/** The host to connect from (default: `127.0.0.1`) */
host?: string;
/** The port to connect from the host (default: `2333`) */
port?: number;
/** The password to authenicate from (default: `youshallnotpass`) */
password?: string;
}
/** Type defintion for: `CommandOptions` */
export type CommandOptions = {
/** The command name */
command: string;
/** The command description */
description: string | Kotori.DescriptionSupplier;
/** The command usage (Use `<command>.getFormat()` to "prettify" the usage) */
usage?: string;
/** The command category (default: `Generic`) */
category?: string;
/** The command aliases (returns an empty array if no aliases were provided) */
aliases?: string[];
/** Whenever or not the command should be executed in a Discord guild */
guildOnly?: boolean;
/** Whenever or not the command should be executed by the owners */
ownerOnly?: boolean;
/** Whenever or not the command should be disabled */
disabled?: boolean;
/** Whenever or not the command should be hidden from the help command */
hidden?: boolean;
/** Whenever or not the command should be executed in an "NSFW" channel */
nsfw?: boolean;
/** The cooldown amount in seconds */
throttle?: number;
}
/** The description supplier as an function */
export type DescriptionSupplier = (client: Kotori.Client) => string;
/** Type defintion for: `ManagerOptions` */
export type ManagerOptions = {
/** The path to add x from */
path: string;
}
/** Type definition for: `Emittable` */
export type Emittable = "ready" | "disconnect" | "callCreate" | "callRing" | "callDelete" |
"callUpdate" | "channelCreate" | "channelDelete" | "channelPinUpdate" | "channelRecipientAdd" |
"channelRecepientRemove" | "channelUpdate" | "friendSuggestionCreate" | "friendSuggestionDelete" | "guildAvaliable" |
"guildBanAdd" | "guildBanRemove" | "guildDelete" | "guildUnavaliable" |
"guildCreate" | "guildEmojisUpdate" | "guildMemberAdd" | "guildMemberChunk" | "guildMemberRemove" | "guildMemberUpdate" |
"guildRoleCreate" | "guildRoleDelete" | "guildRoleUpdate" | "guildUpdate" | "hello" | "messageCreate" | "messageDeleteBulk" |
"messageReactionRemoveAll" | "messageDeleteBulk" | "messageDelete" | "messageReactionAdd" | "messageReactionRemove" | "messageUpdate" |
"presenceUpdate" | "rawWS" | "unknown" | "relationshipAdd" | "relationshipRemove" |
"relationshipUpdate" | "typingStart" | "unavaliableGuildCreate" | "userUpdate" | "voiceChannelJoin" | "voiceChannelLeave" |
"voiceChannelSwitch" | "voiceStateUpdate" | "warn" | "debug" | "shardDisconnect" | "error" | "shardPreReady" | "connect" |
"shardReady" | "shardResume";
/** Type defintion for: `DatabaseManagerOptions` */
export type DatabaseManagerOptions = {
/** The url to authenicate with MongoDB */
url: string;
}
/** Type defitinion for: `IDestroyResult` */
export type IDestroyResult = {
/** If it was successful or not */
success: boolean;
/** If it failed to destroy */
error?: Error;
}
/** Guild Settings */
export type IGuildSettings = {
guildID: string;
prefix: string;
reddit: {
enabled: boolean;
channelID: string;
};
starboard: {
enabled: boolean;
channelID: string;
emoji: string;
threshold: number;
};
modlog: {
enabled: boolean;
channelID: string;
};
suggestions: {
enabled: boolean;
channelID: string;
upvotes: { emoji: string; amount: number; }
downvotes: { emoji: string; amount: number; }
};
tags: {
userID: string;
content: string;
}[];
autoroles: string[];
assignable: string[];
blacklist: { is: boolean; reason: string; }
}
/** Type definiton for: `MessageFilter` */
export type MessageFilter = (msg: Eris.Message) => boolean;
/** Type definition for: `MessageCollectorOptions` */
export type MessageCollectorOptions = {
/** The channel ID */
channelID: string;
/** The user's ID */
userID: string;
/** Timeout number (default: `30`) */
timeout?: number;
}
/** Permission resolvable */
export type PermissionResolvable = string | number | number[];
/** Permission nodes */
export type Permission = "createInstantInvite" | "kickMembers" | "banMembers" |
"administrator" | "manageChannels" | "manageGuild" | "addReactions" | "viewAuditLogs" | "voicePrioritySpeaker" |
"readMessages" | "sendMessages" | "sendTTSMessages" | "manageMessages" | "embedLinks" | "attachFiles" | "readMessageHistory" |
"mentionEveryone" | "externalEmojis" | "voiceConnect" | "voiceSpeak" | "voiceMuteMembers" | "voiceDeafenMembers"|
"voiceUseVAD" | "changeNickname" | "manageNicknames" | "manageRoles" | "manageWebhooks" | "manageEmojis";
/** Type definiton for: `SchedulerOptions` */
export type SchedulerOptions = {
/** The scheduler name */
name: string;
/** Interval number */
interval: number;
/** If the scheduler should be disabled */
disabled?: boolean;
};
export type IUserSettings = {
userID: string;
locale: string;
coins: number;
profile: {
description: string;
badge: string;
}
}
// #endregion Types
}
declare module '@maika.xyz/kotori' {
export = Kotori;
}