@koishijs/plugin-adapter-discord 2.0.0-alpha.7 → 2.0.0-beta.3

package/lib/types/device.d.ts

@@ -0,0 +1,41 @@
+/** https://discord.com/developers/docs/topics/certified-devices#models-device-object */
+export interface Device {
+    /** the type of device */
+    type: DeviceType;
+    /** the device's Windows UUID */
+    id: string;
+    /** the hardware vendor */
+    vendor: Vendor;
+    /** the model of the product */
+    model: Model;
+    /** UUIDs of related devices */
+    related: string[];
+    /** if the device's native echo cancellation is enabled */
+    echo_cancellation?: boolean;
+    /** if the device's native noise suppression is enabled */
+    noise_suppression?: boolean;
+    /** if the device's native automatic gain control is enabled */
+    automatic_gain_control?: boolean;
+    /** if the device is hardware muted */
+    hardware_mute?: boolean;
+}
+/** https://discord.com/developers/docs/topics/certified-devices#models-vendor-object */
+export interface Vendor {
+    /** name of the vendor */
+    name: string;
+    /** url for the vendor */
+    url: string;
+}
+/** https://discord.com/developers/docs/topics/certified-devices#models-model-object */
+export interface Model {
+    /** name of the model */
+    name: string;
+    /** url for the model */
+    url: string;
+}
+/** https://discord.com/developers/docs/topics/certified-devices#models-device-type */
+export declare enum DeviceType {
+    AUDIO_INPUT = "audioinput",
+    AUDIO_OUTPUT = "audiooutput",
+    VIDEO_INPUT = "videoinput"
+}

package/lib/types/emoji.d.ts

@@ -0,0 +1,144 @@
+import { GuildMember, integer, snowflake, User } from '.';
+/** https://discord.com/developers/docs/resources/emoji#emoji-object-emoji-structure */
+export interface Emoji {
+    /** emoji id */
+    id?: snowflake;
+    /** emoji name */
+    name?: string;
+    /** roles allowed to use this emoji */
+    roles?: snowflake[];
+    /** user that created this emoji */
+    user?: User;
+    /** whether this emoji must be wrapped in colons */
+    require_colons?: boolean;
+    /** whether this emoji is managed */
+    managed?: boolean;
+    /** whether this emoji is animated */
+    animated?: boolean;
+    /** whether this emoji can be used, may be false due to loss of Server Boosts */
+    available?: boolean;
+}
+/** https://discord.com/developers/docs/resources/channel#reaction-object-reaction-structure */
+export interface Reaction {
+    /** times this emoji has been used to react */
+    count: integer;
+    /** whether the current user reacted using this emoji */
+    me: boolean;
+    /** emoji information */
+    emoji: Partial<Emoji>;
+}
+/** https://discord.com/developers/docs/topics/gateway#guild-emojis-update-guild-emojis-update-event-fields */
+export interface GuildEmojisUpdateEvent {
+    /** id of the guild */
+    guild_id: snowflake;
+    /** array of emojis */
+    emojis: Emoji[];
+}
+/** https://discord.com/developers/docs/topics/gateway#message-reaction-add-message-reaction-add-event-fields */
+export interface MessageReactionAddEvent {
+    /** the id of the user */
+    user_id: snowflake;
+    /** the id of the channel */
+    channel_id: snowflake;
+    /** the id of the message */
+    message_id: snowflake;
+    /** the id of the guild */
+    guild_id?: snowflake;
+    /** the member who reacted if this happened in a guild */
+    member?: GuildMember;
+    /** the emoji used to react - example */
+    emoji: Partial<Emoji>;
+}
+/** https://discord.com/developers/docs/topics/gateway#message-reaction-remove-message-reaction-remove-event-fields */
+export interface MessageReactionRemoveEvent {
+    /** the id of the user */
+    user_id: snowflake;
+    /** the id of the channel */
+    channel_id: snowflake;
+    /** the id of the message */
+    message_id: snowflake;
+    /** the id of the guild */
+    guild_id?: snowflake;
+    /** the emoji used to react - example */
+    emoji: Partial<Emoji>;
+}
+/** https://discord.com/developers/docs/topics/gateway#message-reaction-remove-all-message-reaction-remove-all-event-fields */
+export interface MessageReactionRemoveAllEvent {
+    /** the id of the channel */
+    channel_id: snowflake;
+    /** the id of the message */
+    message_id: snowflake;
+    /** the id of the guild */
+    guild_id?: snowflake;
+}
+/** https://discord.com/developers/docs/topics/gateway#message-reaction-remove-emoji-message-reaction-remove-emoji */
+export interface MessageReactionRemoveEmojiEvent {
+    /** the id of the channel */
+    channel_id: snowflake;
+    /** the id of the guild */
+    guild_id?: snowflake;
+    /** the id of the message */
+    message_id: snowflake;
+    /** the emoji that was removed */
+    emoji: Partial<Emoji>;
+}
+declare module './gateway' {
+    interface GatewayEvents {
+        /** guild emojis were updated */
+        GUILD_EMOJIS_UPDATE: GuildEmojisUpdateEvent;
+        /** user reacted to a message */
+        MESSAGE_REACTION_ADD: MessageReactionAddEvent;
+        /** user removed a reaction from a message */
+        MESSAGE_REACTION_REMOVE: MessageReactionRemoveEvent;
+        /** all reactions were explicitly removed from a message */
+        MESSAGE_REACTION_REMOVE_ALL: MessageReactionRemoveAllEvent;
+        /** all reactions for a given emoji were explicitly removed from a message */
+        MESSAGE_REACTION_REMOVE_EMOJI: MessageReactionRemoveEmojiEvent;
+    }
+}
+export interface ModifyGuildEmojiOptions {
+    /** name of the emoji */
+    name?: string;
+    /** array of snowflakes	roles allowed to use this emoji */
+    roles?: snowflake[];
+}
+export interface CreateGuildEmojiOptions extends ModifyGuildEmojiOptions {
+    /** the 128x128 emoji image */
+    image: string;
+}
+declare module './internal' {
+    interface Internal {
+        /** https://discord.com/developers/docs/resources/emoji#list-guild-emojis */
+        listGuildEmojis(guild_id: snowflake): Promise<Emoji[]>;
+        /** https://discord.com/developers/docs/resources/emoji#get-guild-emoji */
+        getGuildEmoji(guild_id: snowflake, emoji_id: snowflake): Promise<Emoji>;
+        /** https://discord.com/developers/docs/resources/emoji#create-guild-emoji */
+        createGuildEmoji(guild_id: snowflake, options: CreateGuildEmojiOptions): Promise<Emoji>;
+        /** https://discord.com/developers/docs/resources/emoji#modify-guild-emoji */
+        modifyGuildEmoji(guild_id: snowflake, emoji_id: snowflake, options: ModifyGuildEmojiOptions): Promise<Emoji>;
+        /** https://discord.com/developers/docs/resources/emoji#delete-guild-emoji */
+        deleteGuildEmoji(guild_id: snowflake, emoji_id: snowflake): Promise<void>;
+    }
+}
+export interface GetReactionsOptions {
+    /** get users after this user ID */
+    after?: snowflake;
+    /** max number of users to return (1-100) */
+    limit?: integer;
+}
+declare module './internal' {
+    interface Internal {
+        /** https://discord.com/developers/docs/resources/channel#create-reaction */
+        createReaction(channel_id: snowflake, message_id: snowflake, emoji: string): Promise<void>;
+        /** https://discord.com/developers/docs/resources/channel#delete-own-reaction */
+        deleteOwnReaction(channel_id: snowflake, message_id: snowflake, emoji: string): Promise<void>;
+        /** https://discord.com/developers/docs/resources/channel#delete-user-reaction */
+        deleteUserReaction(channel_id: snowflake, message_id: snowflake, emoji: string, user_id: snowflake): Promise<void>;
+        /** https://discord.com/developers/docs/resources/channel#get-reactions */
+        getReactions(channel_id: snowflake, message_id: snowflake, emoji: string, options?: GetReactionsOptions): Promise<Reaction[]>;
+        /** https://discord.com/developers/docs/resources/channel#delete-all-reactions */
+        deleteAllReactions(channel_id: snowflake, message_id: snowflake): Promise<void>;
+        /** https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji */
+        deleteAllReactionsForEmoji(channel_id: snowflake, message_id: snowflake, emoji: string): Promise<void>;
+    }
+}

package/lib/types/gateway.d.ts

@@ -0,0 +1,242 @@
+import { Activity, integer, snowflake, StatusType } from '.';
+/** https://discord.com/developers/docs/topics/gateway#payloads-gateway-payload-structure */
+export interface GatewayPayloadStructure<O extends GatewayOpcode, T extends keyof GatewayEvents, D> {
+    /** opcode for the payload */
+    op: O;
+    /** event data */
+    d?: D;
+    /** the event name for this payload */
+    t?: T;
+    /** sequence number, used for resuming sessions and heartbeats */
+    s?: number;
+}
+export declare type GatewayPayload = {
+    [O in GatewayOpcode]: O extends GatewayOpcode.DISPATCH ? {
+        [T in keyof GatewayEvents]: GatewayPayloadStructure<GatewayOpcode.DISPATCH, T, GatewayEvents[T]>;
+    }[keyof GatewayEvents] : GatewayPayloadStructure<O, never, O extends keyof GatewayParams ? GatewayParams[O] : never>;
+}[GatewayOpcode];
+/** https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-opcodes */
+export declare enum GatewayOpcode {
+    /** An event was dispatched. */
+    DISPATCH = 0,
+    /** Fired periodically by the client to keep the connection alive. */
+    HEARTBEAT = 1,
+    /** Starts a new session during the initial handshake. */
+    IDENTIFY = 2,
+    /** Update the client's presence. */
+    PRESENCE_UPDATE = 3,
+    /** Used to join/leave or move between voice channels. */
+    VOICE_STATE_UPDATE = 4,
+    /** Resume a previous session that was disconnected. */
+    RESUME = 6,
+    /** You should attempt to reconnect and resume immediately. */
+    RECONNECT = 7,
+    /** Request information about offline guild members in a large guild. */
+    REQUEST_GUILD_MEMBERS = 8,
+    /** The session has been invalidated. You should reconnect and identify/resume accordingly. */
+    INVALID_SESSION = 9,
+    /** Sent immediately after connecting, contains the `heartbeat_interval` to use. */
+    HELLO = 10,
+    /** Sent in response to receiving a heartbeat to acknowledge that it has been received. */
+    HEARTBEAT_ACK = 11
+}
+/** https://discord.com/developers/docs/topics/gateway#gateway-intents */
+export declare enum GatewayIntent {
+    /**
+     * - GUILD_CREATE
+     * - GUILD_UPDATE
+     * - GUILD_DELETE
+     * - GUILD_ROLE_CREATE
+     * - GUILD_ROLE_UPDATE
+     * - GUILD_ROLE_DELETE
+     * - CHANNEL_CREATE
+     * - CHANNEL_UPDATE
+     * - CHANNEL_DELETE
+     * - CHANNEL_PINS_UPDATE
+     * - THREAD_CREATE
+     * - THREAD_UPDATE
+     * - THREAD_DELETE
+     * - THREAD_LIST_SYNC
+     * - THREAD_MEMBER_UPDATE
+     * - THREAD_MEMBERS_UPDATE
+     * - STAGE_INSTANCE_CREATE
+     * - STAGE_INSTANCE_UPDATE
+     * - STAGE_INSTANCE_DELETE
+     */
+    GUILD_CREATE = 1,
+    /**
+     * - GUILD_MEMBER_ADD
+     * - GUILD_MEMBER_UPDATE
+     * - GUILD_MEMBER_REMOVE
+     * - THREAD_MEMBERS_UPDATE
+     */
+    GUILD_MEMBERS = 2,
+    /**
+     * - GUILD_BAN_ADD
+     * - GUILD_BAN_REMOVE
+     */
+    GUILD_BANS = 4,
+    /**
+     * - GUILD_EMOJIS_UPDATE
+     * - GUILD_STICKERS_UPDATE
+     */
+    GUILD_EMOJIS_AND_STICKERS = 8,
+    /**
+     * - GUILD_INTEGRATIONS_UPDATE
+     * - INTEGRATION_CREATE
+     * - INTEGRATION_UPDATE
+     * - INTEGRATION_DELETE
+     */
+    GUILD_INTEGRATIONS = 16,
+    /**
+     * - WEBHOOKS_UPDATE
+     */
+    GUILD_WEBHOOKS = 32,
+    /**
+     * - INVITE_CREATE
+     * - INVITE_DELETE
+     */
+    GUILD_INVITES = 64,
+    /**
+     * - VOICE_STATE_UPDATE
+     */
+    GUILD_VOICE_STATES = 128,
+    /**
+     * - PRESENCE_UPDATE
+     */
+    GUILD_PRESENCES = 256,
+    /**
+     * - MESSAGE_CREATE
+     * - MESSAGE_UPDATE
+     * - MESSAGE_DELETE
+     * - MESSAGE_DELETE_BULK
+     */
+    GUILD_MESSAGES = 512,
+    /**
+     * - MESSAGE_REACTION_ADD
+     * - MESSAGE_REACTION_REMOVE
+     * - MESSAGE_REACTION_REMOVE_ALL
+     * - MESSAGE_REACTION_REMOVE_EMOJI
+     */
+    GUILD_MESSAGE_REACTIONS = 1024,
+    /**
+     * - TYPING_START
+     */
+    GUILD_MESSAGE_TYPING = 2048,
+    /**
+     * - MESSAGE_CREATE
+     * - MESSAGE_UPDATE
+     * - MESSAGE_DELETE
+     * - CHANNEL_PINS_UPDATE
+     */
+    DIRECT_MESSAGES = 4096,
+    /**
+     * - MESSAGE_REACTION_ADD
+     * - MESSAGE_REACTION_REMOVE
+     * - MESSAGE_REACTION_REMOVE_ALL
+     * - MESSAGE_REACTION_REMOVE_EMOJI
+     */
+    DIRECT_MESSAGE_REACTIONS = 8192,
+    /**
+     * - TYPING_START
+     */
+    DIRECT_MESSAGE_TYPING = 16384
+}
+export interface GatewayParams {
+    [GatewayOpcode.HELLO]: HelloParams;
+    [GatewayOpcode.IDENTIFY]: IdentifyParams;
+    [GatewayOpcode.RESUME]: ResumeParams;
+    [GatewayOpcode.REQUEST_GUILD_MEMBERS]: RequestGuildMembersParams;
+    [GatewayOpcode.VOICE_STATE_UPDATE]: VoiceStateUpdateParams;
+    [GatewayOpcode.PRESENCE_UPDATE]: PresenceUpdateParams;
+}
+/** https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events */
+export interface GatewayEvents {
+}
+/** https://discord.com/developers/docs/topics/gateway#identify-identify-structure */
+export interface IdentifyParams {
+    /** authentication token */
+    token: string;
+    /** connection properties */
+    properties: object;
+    /** whether this connection supports compression of packets */
+    compress?: boolean;
+    /** value between 50 and 250, total number of members where the gateway will stop sending offline members in the guild member list */
+    large_threshold?: integer;
+    /** used for Guild Sharding */
+    shard?: [shard_id: integer, num_shards: integer];
+    /** presence structure for initial presence information */
+    presence?: PresenceUpdateParams;
+    /** the Gateway Intents you wish to receive */
+    intents: integer;
+}
+/** https://discord.com/developers/docs/topics/gateway#resume-resume-structure */
+export interface ResumeParams {
+    /** session token */
+    token: string;
+    /** session id */
+    session_id: string;
+    /** last sequence number received */
+    seq: integer;
+}
+/** https://discord.com/developers/docs/topics/gateway#request-guild-members-guild-request-members-structure */
+export interface RequestGuildMembersParams {
+    /** id of the guild to get members for */
+    guild_id: snowflake;
+    /** string that username starts with, or an empty string to return all members */
+    query?: string;
+    /** maximum number of members to send matching the query; a limit of 0 can be used with an empty string query to return all members */
+    limit: integer;
+    /** used to specify if we want the presences of the matched members */
+    presences?: boolean;
+    /** used to specify which users you wish to fetch */
+    user_ids?: snowflake | snowflake[];
+    /** nonce to identify the Guild Members Chunk response */
+    nonce?: string;
+}
+/** https://discord.com/developers/docs/topics/gateway#update-voice-state-gateway-voice-state-update-structure */
+export interface VoiceStateUpdateParams {
+    /** id of the guild */
+    guild_id: snowflake;
+    /** id of the voice channel client wants to join (null if disconnecting) */
+    channel_id?: snowflake;
+    /** is the client muted */
+    self_mute: boolean;
+    /** is the client deafened */
+    self_deaf: boolean;
+}
+/** https://discord.com/developers/docs/topics/gateway#update-presence-gateway-presence-update-structure */
+export interface PresenceUpdateParams {
+    /** unix time (in milliseconds) of when the client went idle, or null if the client is not idle */
+    since?: integer;
+    /** the user's activities */
+    activities: Activity[];
+    /** the user's new status */
+    status: StatusType;
+    /** whether or not the client is afk */
+    afk: boolean;
+}
+/** https://discord.com/developers/docs/topics/gateway#hello-hello-structure */
+export interface HelloParams {
+    /** the interval (in milliseconds) the client should heartbeat with */
+    heartbeat_interval: integer;
+}
+/** https://discord.com/developers/docs/topics/gateway#session-start-limit-object-session-start-limit-structure */
+export interface SessionStartLimit {
+    /** The total number of session starts the current user is allowed */
+    total: integer;
+    /** The remaining number of session starts the current user is allowed */
+    remaining: integer;
+    /** The number of milliseconds after which the limit resets */
+    reset_after: integer;
+    /** The number of identify requests allowed per 5 seconds */
+    max_concurrency: integer;
+}
+declare module './internal' {
+    interface Internal {
+        /** https://discord.com/developers/docs/topics/gateway#get-gateway */
+        getGateway(): Promise<any>;
+        /** https://discord.com/developers/docs/topics/gateway#get-gateway-bot */
+        getGatewayBot(): Promise<any>;
+    }
+}

package/lib/types/guild-member.d.ts

@@ -0,0 +1,110 @@
+import { integer, PresenceUpdateParams, snowflake, timestamp, User } from '.';
+/** https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure */
+export interface GuildMember {
+    /** the user this guild member represents */
+    user?: User;
+    /** this users guild nickname */
+    nick?: string;
+    /** the member's guild avatar hash */
+    avatar?: string;
+    /** array of role object ids */
+    roles: snowflake[];
+    /** when the user joined the guild */
+    joined_at: timestamp;
+    /** when the user started boosting the guild */
+    premium_since?: timestamp;
+    /** whether the user is deafened in voice channels */
+    deaf: boolean;
+    /** whether the user is muted in voice channels */
+    mute: boolean;
+    /** whether the user has not yet passed the guild's Membership Screening requirements */
+    pending?: boolean;
+    /** total permissions of the member in the channel, including overwrites, returned when in the interaction object */
+    permissions?: string;
+}
+/** https://discord.com/developers/docs/topics/gateway#guild-member-add-guild-member-add-extra-fields */
+export interface GuildMemberAddEvent extends GuildMember {
+    /** id of the guild */
+    guild_id: snowflake;
+}
+/** https://discord.com/developers/docs/topics/gateway#guild-member-remove-guild-member-remove-event-fields */
+export interface GuildMemberRemoveEvent {
+    /** the id of the guild */
+    guild_id: snowflake;
+    /** the user who was removed */
+    user: User;
+}
+/** https://discord.com/developers/docs/topics/gateway#guild-member-update-guild-member-update-event-fields */
+export interface GuildMemberUpdateEvent {
+    /** the id of the guild */
+    guild_id: snowflake;
+    /** user role ids */
+    roles: snowflake[];
+    /** the user */
+    user: User;
+    /** nickname of the user in the guild */
+    nick?: string;
+    /** the member's guild avatar hash */
+    avatar?: string;
+    /** when the user joined the guild */
+    joined_at?: timestamp;
+    /** when the user starting boosting the guild */
+    premium_since?: timestamp;
+    /** whether the user is deafened in voice channels */
+    deaf?: boolean;
+    /** whether the user is muted in voice channels */
+    mute?: boolean;
+    /** whether the user has not yet passed the guild's Membership Screening requirements */
+    pending?: boolean;
+}
+/** https://discord.com/developers/docs/topics/gateway#guild-members-chunk-guild-members-chunk-event-fields */
+export interface GuildMembersChunkEvent {
+    /** the id of the guild */
+    guild_id: snowflake;
+    /** set of guild members */
+    members: GuildMember[];
+    /** the chunk index in the expected chunks for this response (0 <= chunk_index < chunk_count) */
+    chunk_index: integer;
+    /** the total number of expected chunks for this response */
+    chunk_count: integer;
+    /** if passing an invalid id to REQUEST_GUILD_MEMBERS, it will be returned here */
+    not_found?: snowflake[];
+    /** if passing true to REQUEST_GUILD_MEMBERS, presences of the returned members will be here */
+    presences?: PresenceUpdateParams[];
+    /** the nonce used in the Guild Members Request */
+    nonce?: string;
+}
+declare module './gateway' {
+    interface GatewayEvents {
+        /** new user joined a guild */
+        GUILD_MEMBER_ADD: GuildMemberAddEvent;
+        /** user was removed from a guild */
+        GUILD_MEMBER_REMOVE: GuildMemberRemoveEvent;
+        /** guild member was updated */
+        GUILD_MEMBER_UPDATE: GuildMemberUpdateEvent;
+        /** response to Request Guild Members */
+        GUILD_MEMBERS_CHUNK: GuildMembersChunkEvent;
+    }
+}
+export interface ListGuildMembersOptions {
+    /** max number of members to return (1-1000) */
+    limit?: integer;
+    /** the highest user id in the previous page */
+    after?: snowflake;
+}
+export interface SearchGuildMembersOptions {
+    /** query string to match username(s) and nickname(s) against */
+    query: string;
+    /** max number of members to return (1-1000) */
+    limit?: integer;
+}
+declare module './internal' {
+    interface Internal {
+        /** https://discord.com/developers/docs/resources/guild#get-guild-member */
+        getGuildMember(guild_id: snowflake, user_id: snowflake): Promise<GuildMember>;
+        /** https://discord.com/developers/docs/resources/guild#list-guild-members */
+        listGuildMembers(guild_id: snowflake, options?: ListGuildMembersOptions): Promise<GuildMember[]>;
+        /** https://discord.com/developers/docs/resources/guild#search-guild-members */
+        searchGuildMembers(guild_id: snowflake, options: SearchGuildMembersOptions): Promise<GuildMember[]>;
+    }
+}

package/lib/types/guild-template.d.ts

@@ -0,0 +1,26 @@
+import { Guild, integer, snowflake, timestamp, User } from '.';
+/** https://discord.com/developers/docs/resources/guild-template#guild-template-object-guild-template-structure */
+export interface GuildTemplate {
+    /** the template code (unique ID) */
+    code: string;
+    /** template name */
+    name: string;
+    /** the description for the template */
+    description?: string;
+    /** number of times this template has been used */
+    usage_count: integer;
+    /** the ID of the user who created the template */
+    creator_id: snowflake;
+    /** the user who created the template */
+    creator: User;
+    /** when this template was created */
+    created_at: timestamp;
+    /** when this template was last synced to the source guild */
+    updated_at: timestamp;
+    /** the ID of the guild this template is based on */
+    source_guild_id: snowflake;
+    /** the guild snapshot this template contains */
+    serialized_source_guild: Partial<Guild>;
+    /** whether the template has unsynced changes */
+    is_dirty?: boolean;
+}