chapterjs 0.1.2 → 0.2.0

package/dist/events/registry.d.ts

@@ -0,0 +1,697 @@
+import type { CacheLimits } from '../cache/cache.js';
+import type { Snowflake } from '../discord/types/common.js';
+import type { GatewayDispatchEventName, GatewayDispatchEvents } from '../discord/types/gateway-events.js';
+import type { Channel, DMChannel, GuildChannel, GuildTextBasedChannel, TextBasedChannel, ThreadChannel, VoiceChannel } from '../structures/channel.js';
+import type { Context } from '../structures/context.js';
+import type { GuildEmoji } from '../structures/emoji.js';
+import type { AuditLogEntry, Guild, ScheduledEvent, VoiceState } from '../structures/guild.js';
+import type { Invite } from '../structures/invite.js';
+import type { GuildMember } from '../structures/member.js';
+import type { DmMessage, GuildMessage, MemberMessage, Message, PrivateMessage, ReactionEmoji } from '../structures/message.js';
+import type { Role } from '../structures/role.js';
+import type { User, UserPresence } from '../structures/user.js';
+import type { TranslationContext } from '../messages/messages.js';
+/** What your function receives, for each event. */
+export interface EventContexts {
+    /** The bot is connected and knows every server it is in. */
+    ready: {
+        /** The bot itself. */
+        user: User;
+        /** The servers the bot is in. */
+        guilds: ReadonlyMap<Snowflake, Guild>;
+    };
+    /** A message was sent, in a server or in private. */
+    messageCreate: {
+        /** The message that was sent. */
+        message: Message;
+    };
+    /** A message was edited. */
+    messageUpdate: {
+        /** The message, as it is now. */
+        message: Message;
+    };
+    /** A message was deleted. */
+    messageDelete: {
+        /** The id of the deleted message. */
+        messageId: Snowflake;
+        /** The id of the channel the message was in. */
+        channelId: Snowflake;
+        /** The id of the server; `null` for a private message. */
+        guildId: Snowflake | null;
+        /** The server; `null` for a private message. */
+        guild: Guild | null;
+        /** The channel, when the bot knows it. */
+        channel: TextBasedChannel | null;
+        /** The message as it was, when the bot remembered it. */
+        message: Message | null;
+    };
+    /** Someone joined a server. */
+    memberJoin: {
+        /** The new member. */
+        member: GuildMember;
+        /** The server they joined. */
+        guild: Guild;
+    };
+    /** Someone left a server, or was kicked or banned. */
+    memberLeave: {
+        /** The account of who left. */
+        user: User;
+        /** The server they left. */
+        guild: Guild;
+        /** The member as it was, when the bot knew it. */
+        member: GuildMember | null;
+    };
+    /** A member changed: nickname, roles, timeout, avatar... */
+    memberUpdate: {
+        /** The member, as they are now. */
+        member: GuildMember;
+        /** The server of the member. */
+        guild: Guild;
+    };
+    /** The bot was added to a server. */
+    guildJoin: {
+        /** The server the bot was added to. */
+        guild: Guild;
+    };
+    /** The bot was removed from a server. */
+    guildLeave: {
+        /** The server as it was, when the bot was in it. */
+        guild: Guild;
+    };
+    /** A channel was created. */
+    channelCreate: {
+        /** The new channel or thread. */
+        channel: GuildChannel | ThreadChannel | Channel;
+    };
+    /** A channel changed: name, topic, permissions... */
+    channelUpdate: {
+        /** The channel or thread, as it is now. */
+        channel: GuildChannel | ThreadChannel | Channel;
+    };
+    /** A channel was deleted. */
+    channelDelete: {
+        /** The channel or thread as it was. */
+        channel: GuildChannel | ThreadChannel | Channel;
+    };
+    /** A role was created. */
+    roleCreate: {
+        /** The new role. */
+        role: Role;
+        /** The server of the role. */
+        guild: Guild;
+    };
+    /** A role changed: name, color, permissions, position... */
+    roleUpdate: {
+        /** The role, as it is now. */
+        role: Role;
+        /** The server of the role. */
+        guild: Guild;
+    };
+    /** A role was deleted. */
+    roleDelete: {
+        /** The id of the deleted role. */
+        roleId: Snowflake;
+        /** The server the role was in. */
+        guild: Guild;
+        /** The role as it was. */
+        role: Role;
+    };
+    /** The server changed: name, icon, settings... */
+    guildUpdate: {
+        /** The server, as it is now. */
+        guild: Guild;
+    };
+    /** Someone was banned from a server. */
+    banAdd: {
+        /** The account that was banned. */
+        user: User;
+        /** The server they were banned from. */
+        guild: Guild;
+    };
+    /** A ban was lifted: the person can join the server again. */
+    banRemove: {
+        /** The account that is no longer banned. */
+        user: User;
+        /** The server of the ban. */
+        guild: Guild;
+    };
+    /** An emoji was added to a server. */
+    emojiCreate: {
+        /** The new emoji. */
+        emoji: GuildEmoji;
+        /** The server of the emoji. */
+        guild: Guild;
+    };
+    /** An emoji of a server changed: its name, or who can use it. */
+    emojiUpdate: {
+        /** The emoji, as it is now. */
+        emoji: GuildEmoji;
+        /** The server of the emoji. */
+        guild: Guild;
+    };
+    /** An emoji was removed from a server. */
+    emojiDelete: {
+        /** The emoji as it was. */
+        emoji: GuildEmoji;
+        /** The server the emoji was in. */
+        guild: Guild;
+    };
+    /** An invite to a server was created. */
+    inviteCreate: {
+        /** The new invite. */
+        invite: Invite;
+        /** The server the invite leads to. */
+        guild: Guild;
+        /** The channel the invite leads to. */
+        channel: GuildChannel;
+    };
+    /** An invite was deleted, or expired. */
+    inviteDelete: {
+        /** The code of the invite (`discord.gg/code`). */
+        code: string;
+        /** The server the invite led to. */
+        guild: Guild;
+        /** The channel the invite led to. */
+        channel: GuildChannel;
+    };
+    /** Something was added to the audit log of a server. */
+    auditLogEntryCreate: {
+        /** What was done, by whom, on what. */
+        entry: AuditLogEntry;
+        /** The server of the audit log. */
+        guild: Guild;
+    };
+    /** Someone added a reaction to a message. */
+    reactionAdd: {
+        /** The emoji of the reaction. */
+        emoji: ReactionEmoji;
+        /** Who reacted. */
+        user: User;
+        /** Who reacted, as a member of the server; `null` in a private message. */
+        member: GuildMember | null;
+        /** Whether it is a super reaction. */
+        burst: boolean;
+        /** The id of the message. */
+        messageId: Snowflake;
+        /** The message, when the bot remembers it. */
+        message: Message | null;
+        /** The id of who wrote the message, when Discord says it. */
+        messageAuthorId: Snowflake | null;
+        /** The id of the channel of the message. */
+        channelId: Snowflake;
+        /** The channel of the message, when the bot knows it. */
+        channel: TextBasedChannel | null;
+        /** The id of the server; `null` in a private message. */
+        guildId: Snowflake | null;
+        /** The server; `null` in a private message. */
+        guild: Guild | null;
+    };
+    /** Someone removed their reaction from a message. */
+    reactionRemove: {
+        /** The emoji of the reaction. */
+        emoji: ReactionEmoji;
+        /** Who had reacted. */
+        user: User;
+        /** Who had reacted, as a member of the server, when the bot remembers it. */
+        member: GuildMember | null;
+        /** Whether it was a super reaction. */
+        burst: boolean;
+        /** The id of the message. */
+        messageId: Snowflake;
+        /** The message, when the bot remembers it. */
+        message: Message | null;
+        /** The id of the channel of the message. */
+        channelId: Snowflake;
+        /** The channel of the message, when the bot knows it. */
+        channel: TextBasedChannel | null;
+        /** The id of the server; `null` in a private message. */
+        guildId: Snowflake | null;
+        /** The server; `null` in a private message. */
+        guild: Guild | null;
+    };
+    /** The reactions of a message were removed: all of them, or every reaction of one emoji. */
+    reactionClear: {
+        /** The emoji whose reactions were removed; `null` when all were. */
+        emoji: ReactionEmoji | null;
+        /** The id of the message. */
+        messageId: Snowflake;
+        /** The message, when the bot remembers it. */
+        message: Message | null;
+        /** The id of the channel of the message. */
+        channelId: Snowflake;
+        /** The channel of the message, when the bot knows it. */
+        channel: TextBasedChannel | null;
+        /** The id of the server; `null` in a private message. */
+        guildId: Snowflake | null;
+        /** The server; `null` in a private message. */
+        guild: Guild | null;
+    };
+    /** Someone voted in a poll. */
+    pollVoteAdd: {
+        /** The id Discord gave to the answer they voted for: today, its position in the poll, `1` for the first answer. */
+        answerId: number;
+        /** Who voted. */
+        user: User;
+        /** Who voted, as a member of the server, when the bot remembers it. */
+        member: GuildMember | null;
+        /** The id of the message of the poll. */
+        messageId: Snowflake;
+        /** The message of the poll, when the bot remembers it. */
+        message: Message | null;
+        /** The id of the channel of the poll. */
+        channelId: Snowflake;
+        /** The channel of the poll, when the bot knows it. */
+        channel: TextBasedChannel | null;
+        /** The id of the server; `null` in a private message. */
+        guildId: Snowflake | null;
+        /** The server; `null` in a private message. */
+        guild: Guild | null;
+    };
+    /** Someone took back their vote in a poll. */
+    pollVoteRemove: {
+        /** The id Discord gave to the answer they no longer vote for: today, its position in the poll, `1` for the first answer. */
+        answerId: number;
+        /** Who had voted. */
+        user: User;
+        /** Who had voted, as a member of the server, when the bot remembers it. */
+        member: GuildMember | null;
+        /** The id of the message of the poll. */
+        messageId: Snowflake;
+        /** The message of the poll, when the bot remembers it. */
+        message: Message | null;
+        /** The id of the channel of the poll. */
+        channelId: Snowflake;
+        /** The channel of the poll, when the bot knows it. */
+        channel: TextBasedChannel | null;
+        /** The id of the server; `null` in a private message. */
+        guildId: Snowflake | null;
+        /** The server; `null` in a private message. */
+        guild: Guild | null;
+    };
+    /** Someone started typing in a channel. */
+    typingStart: {
+        /** Who is typing. */
+        user: User;
+        /** Who is typing, as a member of the server; `null` in a private message. */
+        member: GuildMember | null;
+        /** When they started. */
+        startedAt: Date;
+        /** The id of the channel. */
+        channelId: Snowflake;
+        /** The channel, when the bot knows it. */
+        channel: TextBasedChannel | null;
+        /** The id of the server; `null` in a private message. */
+        guildId: Snowflake | null;
+        /** The server; `null` in a private message. */
+        guild: Guild | null;
+    };
+    /** Someone was added to a thread, or joined it. */
+    threadMemberJoin: {
+        /** The thread. */
+        thread: ThreadChannel;
+        /** Who was added, as a member of the server. */
+        member: GuildMember;
+        /** The account of who was added. */
+        user: User;
+        /** The server of the thread. */
+        guild: Guild;
+    };
+    /** Someone was removed from a thread, or left it. */
+    threadMemberLeave: {
+        /** The thread. */
+        thread: ThreadChannel;
+        /** The id of who was removed. */
+        userId: Snowflake;
+        /** The account of who was removed, when the bot knows it. */
+        user: User | null;
+        /** Who was removed, as a member of the server, when the bot remembers it. */
+        member: GuildMember | null;
+        /** The server of the thread. */
+        guild: Guild;
+    };
+    /** Someone joined a voice channel. */
+    voiceJoin: {
+        /** Who joined. */
+        member: GuildMember;
+        /** The channel they joined. */
+        channel: VoiceChannel;
+        /** Their voice state: muted, deafened, streaming... */
+        voice: VoiceState;
+        /** The server of the channel. */
+        guild: Guild;
+    };
+    /** Someone left a voice channel, or was disconnected. */
+    voiceLeave: {
+        /** Who left. */
+        member: GuildMember;
+        /** The channel they left. */
+        channel: VoiceChannel;
+        /** Their voice state as it was, in that channel. */
+        voice: VoiceState;
+        /** The server of the channel. */
+        guild: Guild;
+    };
+    /** Someone went from one voice channel to another, or was moved. */
+    voiceMove: {
+        /** Who moved. */
+        member: GuildMember;
+        /** The channel they left. */
+        from: VoiceChannel;
+        /** The channel they are in now. */
+        to: VoiceChannel;
+        /** Their voice state, as it is now. */
+        voice: VoiceState;
+        /** The server of the channels. */
+        guild: Guild;
+    };
+    /** Someone in a voice channel changed: muted, deafened, started a stream or a camera... */
+    voiceUpdate: {
+        /** Who changed. */
+        member: GuildMember;
+        /** The channel they are in. */
+        channel: VoiceChannel;
+        /** Their voice state, as it is now. */
+        voice: VoiceState;
+        /** Their voice state as it was. */
+        before: VoiceState;
+        /** The server of the channel. */
+        guild: Guild;
+    };
+    /** Someone's status or activity changed: online, idle, playing a game... */
+    presenceUpdate: {
+        /** The id of whose presence changed. */
+        userId: Snowflake;
+        /** The account of whose presence changed, when the bot knows it. */
+        user: User | null;
+        /** Whose presence changed, as a member of the server, when the bot remembers it. */
+        member: GuildMember | null;
+        /** Their status, activities and devices, as they are now. */
+        presence: UserPresence;
+        /** The server the change is seen from. */
+        guild: Guild;
+    };
+    /** An event was scheduled in a server. */
+    scheduledEventCreate: {
+        /** The new scheduled event. */
+        scheduledEvent: ScheduledEvent;
+        /** The server of the scheduled event. */
+        guild: Guild;
+    };
+    /** A scheduled event changed: its time, its place, or it started or ended. */
+    scheduledEventUpdate: {
+        /** The scheduled event, as it is now. */
+        scheduledEvent: ScheduledEvent;
+        /** The server of the scheduled event. */
+        guild: Guild;
+    };
+    /** A scheduled event was deleted. */
+    scheduledEventDelete: {
+        /** The scheduled event as it was. */
+        scheduledEvent: ScheduledEvent;
+        /** The server the scheduled event was in. */
+        guild: Guild;
+    };
+    /** Someone said they are interested in a scheduled event. */
+    scheduledEventUserAdd: {
+        /** The id of the scheduled event. */
+        scheduledEventId: Snowflake;
+        /** Who is interested. */
+        user: User;
+        /** Who is interested, as a member of the server, when the bot remembers it. */
+        member: GuildMember | null;
+        /** The server of the scheduled event. */
+        guild: Guild;
+    };
+    /** Someone is no longer interested in a scheduled event. */
+    scheduledEventUserRemove: {
+        /** The id of the scheduled event. */
+        scheduledEventId: Snowflake;
+        /** Who is no longer interested. */
+        user: User;
+        /** Who is no longer interested, as a member of the server, when the bot remembers it. */
+        member: GuildMember | null;
+        /** The server of the scheduled event. */
+        guild: Guild;
+    };
+}
+/** The name of an event: the name of a folder of `src/events/`. */
+export type EventName = keyof EventContexts;
+/**
+ * Where something happens: in servers (`'guild'`), in private messages with
+ * the bot (`'dm'`), or in both.
+ */
+export type EventWhere = 'guild' | 'dm' | 'both';
+/** The option of the events that also happen in private messages. */
+export interface WhereEventOptions {
+    /**
+     * Where the file listens: `'guild'` (in servers, the default), `'dm'` (in
+     * private messages with the bot) or `'both'`. What the function receives
+     * follows it: a server that is always there, never there, or to check.
+     */
+    where?: EventWhere;
+}
+/** Options of the events about messages. */
+export interface MessageEventOptions extends WhereEventOptions {
+    /**
+     * Also run for messages written by bots (this one included) and by
+     * webhooks. By default they are ignored: a bot that answers bots can end
+     * up answering itself, or another bot, forever.
+     */
+    bots?: boolean;
+}
+/**
+ * The options a file can give to `event()` as its second argument, for the
+ * events that have some.
+ */
+/** Options of the events about reactions added or removed. */
+export interface ReactionEventOptions extends WhereEventOptions {
+    /**
+     * Also run for the reactions of bots, this one included. By default they
+     * are ignored: a bot that reacts to reactions can end up answering its
+     * own, forever.
+     */
+    bots?: boolean;
+}
+export interface EventOptions {
+    messageCreate: MessageEventOptions;
+    messageUpdate: MessageEventOptions;
+    messageDelete: WhereEventOptions;
+    reactionAdd: ReactionEventOptions;
+    reactionRemove: ReactionEventOptions;
+    reactionClear: WhereEventOptions;
+    pollVoteAdd: WhereEventOptions;
+    pollVoteRemove: WhereEventOptions;
+    typingStart: WhereEventOptions;
+}
+/**
+ * Whether a file turned an option on, from the type of what it passed. An
+ * option that is only known to be a boolean counts: it may be on.
+ */
+type IsOn<Options, Key extends string> = Key extends keyof Options ? Exclude<Options[Key], undefined> extends false ? false : true : false;
+/**
+ * Where a file listens, from the type of what it passed: in servers when
+ * it says nothing, every place it may be when it is only known to be one.
+ */
+type WhereOf<Options> = 'where' extends keyof Options ? [Exclude<Options['where'], undefined>] extends [never] ? 'guild' : Exclude<Options['where'], undefined> : 'guild';
+/** A message of a server: its author is a member unless bots are let in. */
+type ServerMessage<Options> = IsOn<Options, 'bots'> extends true ? GuildMessage : MemberMessage;
+/** The message a file receives: what its options let through. */
+type MessageFor<Options, Where = WhereOf<Options>> = Where extends 'guild' ? ServerMessage<Options> : Where extends 'dm' ? DmMessage : ServerMessage<Options> | PrivateMessage;
+type Deleted = Omit<EventContexts['messageDelete'], 'guildId' | 'guild' | 'channel' | 'message'>;
+/** A message deleted in a server. */
+interface DeletedInGuild extends Deleted {
+    /** The id of the server. */
+    guildId: Snowflake;
+    /** The server the message was in. */
+    guild: Guild;
+    /** The channel the message was in. */
+    channel: GuildTextBasedChannel;
+    /** The message as it was, when the bot remembered it. */
+    message: GuildMessage | null;
+}
+/** A private message deleted, for a file that receives both kinds. */
+interface DeletedInPrivate extends Deleted {
+    /** No server: the message was private. */
+    guildId: null;
+    /** No server: the message was private. */
+    guild: null;
+    /** The private conversation, when the bot knows it. */
+    channel: DMChannel | null;
+    /** The message as it was, when the bot remembered it. */
+    message: PrivateMessage | null;
+}
+/** A private message deleted, for a file that only receives those. */
+interface DeletedInDm extends Deleted {
+    /** The private conversation, when the bot knows it. */
+    channel: DMChannel | null;
+    /** The message as it was, when the bot remembered it. */
+    message: DmMessage | null;
+}
+type DeletedFor<Where> = Where extends 'guild' ? DeletedInGuild : Where extends 'dm' ? DeletedInDm : DeletedInGuild | DeletedInPrivate;
+/** Where something happened in a server: the server and the channel are there. */
+interface ServerPlace {
+    /** The id of the server. */
+    guildId: Snowflake;
+    /** The server. */
+    guild: Guild;
+    /** The channel. */
+    channel: GuildTextBasedChannel;
+}
+/** Where something happened in private, for a file that receives both kinds. */
+interface PrivatePlace {
+    /** No server: it happened in private. */
+    guildId: null;
+    /** No server: it happened in private. */
+    guild: null;
+    /** The private conversation, when the bot knows it. */
+    channel: DMChannel | null;
+}
+/** Where something happened in private, for a file that only receives that. */
+interface DmPlace {
+    /** The private conversation, when the bot knows it. */
+    channel: DMChannel | null;
+}
+/** The message of something that happened in a server. */
+interface ServerMessagePart {
+    /** The message, when the bot remembers it. */
+    message: GuildMessage | null;
+}
+/** The message of something that happened in private, for both kinds. */
+interface PrivateMessagePart {
+    /** The message, when the bot remembers it. */
+    message: PrivateMessage | null;
+}
+/** The message of something that happened in private, for that only. */
+interface DmMessagePart {
+    /** The message, when the bot remembers it. */
+    message: DmMessage | null;
+}
+/** The fields an event of servers and private messages narrows. */
+type PlaceKeys = 'guildId' | 'guild' | 'channel' | 'message' | 'member';
+/**
+ * What a file receives for an event of servers and private messages,
+ * following where it listens: the same fields, plus what each place has.
+ */
+type Placed<Where, Common, InServer, InPrivate, InDm> = Where extends 'guild' ? Common & InServer : Where extends 'dm' ? Common & InDm : (Common & InServer) | (Common & InPrivate);
+/** An event about a message, with or without the member who did it. */
+type OnMessage<Name extends EventName, Options, Member> = Placed<WhereOf<Options>, Omit<EventContexts[Name], PlaceKeys>, ServerPlace & ServerMessagePart & Member, PrivatePlace & PrivateMessagePart & ([keyof Member] extends [never] ? object : NoMember), DmPlace & DmMessagePart>;
+/** No member in private: who did it is `user`. */
+interface NoMember {
+    /** No member: it happened in private. */
+    member: null;
+}
+/** The member who did it, sent with the event. */
+interface SentMember {
+    /** Who did it, as a member of the server. */
+    member: GuildMember;
+}
+/** The member who did it, when the bot remembers it. */
+interface KnownMember {
+    /** Who did it, as a member of the server, when the bot remembers it. */
+    member: GuildMember | null;
+}
+/**
+ * The events whose handler receives something more precise than
+ * `EventContexts`, following where its file listens.
+ */
+interface NarrowedContexts<Options> {
+    messageCreate: {
+        message: MessageFor<Options>;
+    };
+    messageUpdate: {
+        message: MessageFor<Options>;
+    };
+    messageDelete: DeletedFor<WhereOf<Options>>;
+    reactionAdd: OnMessage<'reactionAdd', Options, SentMember>;
+    reactionRemove: OnMessage<'reactionRemove', Options, KnownMember>;
+    reactionClear: OnMessage<'reactionClear', Options, object>;
+    pollVoteAdd: OnMessage<'pollVoteAdd', Options, KnownMember>;
+    pollVoteRemove: OnMessage<'pollVoteRemove', Options, KnownMember>;
+    typingStart: Placed<WhereOf<Options>, Omit<EventContexts['typingStart'], PlaceKeys>, ServerPlace & SentMember, PrivatePlace & NoMember, DmPlace>;
+}
+/**
+ * What your function receives for an event, given the options its file passed
+ * to `event()`. `EventContexts` is the widest form: every option on.
+ */
+export type ContextOf<Name extends EventName, Options = object> = (Name extends keyof NarrowedContexts<Options> ? NarrowedContexts<Options>[Name] : EventContexts[Name]) & TranslationContext;
+/** The options of an event; nothing for an event without options. */
+export type OptionsOf<Name extends EventName> = Name extends keyof EventOptions ? EventOptions[Name] : {};
+/** One gateway event an event comes from. */
+interface Source<Name extends EventName, E extends GatewayDispatchEventName> {
+    on: E;
+    /**
+     * Reads what the event removes from the cache, before it is removed (the
+     * message, member or role "as it was").
+     */
+    before?: (ctx: Context, data: GatewayDispatchEvents[E]) => unknown;
+    /**
+     * Gets from Discord what the handlers are promised and the bot does not
+     * know yet, before they run. Returns nothing when there is nothing to
+     * get, which is nearly always: the event is then delivered at once.
+     */
+    prepare?: (ctx: Context, data: GatewayDispatchEvents[E]) => Promise<unknown> | undefined;
+    /**
+     * Builds what the handler receives, once the cache reflects the event.
+     * `null` means the event does not happen (a server the bot was already
+     * in sending its data is not a server it joined, for example); a list
+     * means it happened several times at once (messages deleted together).
+     * `prepared` is what `prepare` resolved to.
+     */
+    build: (ctx: Context, data: GatewayDispatchEvents[E], extra: {
+        joined: boolean;
+        before: unknown;
+        prepared: unknown;
+    }) => EventContexts[Name] | readonly EventContexts[Name][] | null;
+}
+export interface EventDefinition<Name extends EventName = EventName> {
+    /**
+     * The intents that make Discord send this event; from the options of a
+     * file when they depend on them, so that nothing is asked to Discord for
+     * what no file wants.
+     */
+    intents: number | ((options: OptionsOf<Name>) => number);
+    /**
+     * What the bot must remember for this event to give all it can, when it
+     * is more than the default: nothing is kept for what no file uses.
+     */
+    remembers?: Partial<CacheLimits>;
+    /**
+     * The options a file can pass to `event()`, with the type of each. An
+     * event without this has no options.
+     */
+    options?: {
+        [Key in keyof OptionsOf<Name>]-?: 'boolean' | readonly string[];
+    };
+    /**
+     * Whether a file wants this occurrence of the event, given its options.
+     * Decided per file: two files of the same folder can differ.
+     */
+    accepts?: (context: EventContexts[Name], options: OptionsOf<Name>) => boolean;
+    /**
+     * The server the event happened in, read from what the handler receives:
+     * the language `t` speaks. Left out for what happens outside servers.
+     */
+    guildOf?: (context: EventContexts[Name]) => Guild | null;
+    sources: {
+        [E in GatewayDispatchEventName]: Source<Name, E>;
+    }[GatewayDispatchEventName][];
+}
+/**
+ * Discord refused what an event needs before it can be given to its files:
+ * the channel it happened in, or the user who did it.
+ */
+export declare class MissingForEvent extends Error {
+    readonly what: 'channel' | 'user';
+    readonly cause: unknown;
+    constructor(what: 'channel' | 'user', cause: unknown);
+}
+/**
+ * The events, by name. `ready` has no source: it is not a gateway event but
+ * the moment the bot has finished connecting.
+ */
+export declare const EVENTS: {
+    [Name in EventName]: EventDefinition<Name>;
+};
+export declare const EVENT_NAMES: EventName[];
+export declare function isEventName(name: unknown): name is EventName;
+export {};