@satorijs/adapter-discord 4.1.3 → 4.1.4

package/src/types/gateway.ts

@@ -0,0 +1,334 @@
+import { Activity, integer, Internal, snowflake, StatusType } from '.'
+
+export namespace Gateway {
+  /** https://discord.com/developers/docs/topics/gateway-events#payload-structure */
+  export interface PayloadStructure<O extends Opcode, 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 type Payload = {
+    [O in Opcode]: O extends Opcode.DISPATCH
+      ? {
+        [T in keyof GatewayEvents]: PayloadStructure<Opcode.DISPATCH, T, GatewayEvents[T]>
+      }[keyof GatewayEvents]
+      : PayloadStructure<O, never, O extends keyof Params ? Params[O] : never>
+  }[Opcode]
+
+  /** https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-opcodes */
+  export enum Opcode {
+    /** 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 enum Intent {
+    /**
+     * - 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
+     */
+    GUILDS = 1 << 0,
+    /**
+     * - GUILD_MEMBER_ADD
+     * - GUILD_MEMBER_UPDATE
+     * - GUILD_MEMBER_REMOVE
+     * - THREAD_MEMBERS_UPDATE
+     */
+    GUILD_MEMBERS = 1 << 1,
+    /**
+     * - GUILD_BAN_ADD
+     * - GUILD_BAN_REMOVE
+     */
+    GUILD_BANS = 1 << 2,
+    /**
+     * - GUILD_EMOJIS_UPDATE
+     * - GUILD_STICKERS_UPDATE
+     */
+    GUILD_EMOJIS_AND_STICKERS = 1 << 3,
+    /**
+     * - GUILD_INTEGRATIONS_UPDATE
+     * - INTEGRATION_CREATE
+     * - INTEGRATION_UPDATE
+     * - INTEGRATION_DELETE
+     */
+    GUILD_INTEGRATIONS = 1 << 4,
+    /**
+     * - WEBHOOKS_UPDATE
+     */
+    GUILD_WEBHOOKS = 1 << 5,
+    /**
+     * - INVITE_CREATE
+     * - INVITE_DELETE
+     */
+    GUILD_INVITES = 1 << 6,
+    /**
+     * - VOICE_STATE_UPDATE
+     */
+    GUILD_VOICE_STATES = 1 << 7,
+    /**
+     * - PRESENCE_UPDATE
+     */
+    GUILD_PRESENCES = 1 << 8,
+    /**
+     * - MESSAGE_CREATE
+     * - MESSAGE_UPDATE
+     * - MESSAGE_DELETE
+     * - MESSAGE_DELETE_BULK
+     */
+    GUILD_MESSAGES = 1 << 9,
+    /**
+     * - MESSAGE_REACTION_ADD
+     * - MESSAGE_REACTION_REMOVE
+     * - MESSAGE_REACTION_REMOVE_ALL
+     * - MESSAGE_REACTION_REMOVE_EMOJI
+     */
+    GUILD_MESSAGE_REACTIONS = 1 << 10,
+    /**
+     * - TYPING_START
+     */
+    GUILD_MESSAGE_TYPING = 1 << 11,
+    /**
+     * - MESSAGE_CREATE
+     * - MESSAGE_UPDATE
+     * - MESSAGE_DELETE
+     * - CHANNEL_PINS_UPDATE
+     */
+    DIRECT_MESSAGES = 1 << 12,
+    /**
+     * - MESSAGE_REACTION_ADD
+     * - MESSAGE_REACTION_REMOVE
+     * - MESSAGE_REACTION_REMOVE_ALL
+     * - MESSAGE_REACTION_REMOVE_EMOJI
+     */
+    DIRECT_MESSAGE_REACTIONS = 1 << 13,
+    /**
+     * - TYPING_START
+     */
+    DIRECT_MESSAGE_TYPING = 1 << 14,
+    /**
+     * `MESSAGE_CONTENT` is a unique privileged intent that isn't directly associated with any Gateway events.
+     * Instead, access to `MESSAGE_CONTENT` permits your app to receive message content data across the APIs.
+     *
+     * Any fields affected by the message content intent are noted in the relevant documentation.
+     * For example, the content, embeds, attachments, and components fields in message objects all contain message content and therefore require the intent.
+     *
+     * Like other privileged intents, `MESSAGE_CONTENT` must be approved for your app.
+     * After your app is verified, you can apply for the intent from your app's settings within the Developer Portal.
+     * You can read more about the message content intent review policy in the [Help Center](https://support-dev.discord.com/hc/en-us/articles/5324827539479).
+     *
+     * Apps without the intent will receive empty values in fields that contain user-inputted content with a few exceptions:
+     * - Content in messages that an app sends
+     * - Content in DMs with the app
+     * - Content in which the app is mentioned
+     *
+     * @see https://discord.com/developers/docs/topics/gateway#message-content-intent
+     */
+    MESSAGE_CONTENT = 1 << 15,
+    /**
+     * - GUILD_SCHEDULED_EVENT_CREATE
+     * - GUILD_SCHEDULED_EVENT_UPDATE
+     * - GUILD_SCHEDULED_EVENT_DELETE
+     * - GUILD_SCHEDULED_EVENT_USER_ADD
+     * - GUILD_SCHEDULED_EVENT_USER_REMOVE
+     */
+    GUILD_SCHEDULED_EVENTS = 1 << 16,
+    /**
+     * - AUTO_MODERATION_RULE_CREATE
+     * - AUTO_MODERATION_RULE_UPDATE
+     * - AUTO_MODERATION_RULE_DELETE
+     */
+    AUTO_MODERATION_CONFIGURATION = 1 << 20,
+    /**
+     * - AUTO_MODERATION_ACTION_EXECUTION
+     */
+    AUTO_MODERATION_EXECUTION = 1 << 21,
+  }
+
+  export interface Params {
+    [Opcode.HELLO]: Params.Hello
+    [Opcode.IDENTIFY]: Params.Identify
+    [Opcode.RESUME]: Params.Resume
+    [Opcode.REQUEST_GUILD_MEMBERS]: Params.RequestGuildMembers
+    [Opcode.VOICE_STATE_UPDATE]: Params.VoiceStateUpdate
+    [Opcode.PRESENCE_UPDATE]: Params.PresenceUpdate
+  }
+
+  export namespace Params {
+    /** https://discord.com/developers/docs/topics/gateway-events#hello-hello-structure */
+    export interface Hello {
+      /** the interval (in milliseconds) the client should heartbeat with */
+      heartbeat_interval: integer
+    }
+
+    /** https://discord.com/developers/docs/topics/gateway-events#identify-identify-structure */
+    export interface Identify {
+      /** authentication token */
+      token: string
+      /** connection properties */
+      properties: ConnectionProperties
+      /** 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?: PresenceUpdate
+      /** the Gateway Intents you wish to receive */
+      intents: integer
+    }
+
+    /** https://discord.com/developers/docs/topics/gateway-events#identify-identify-connection-properties */
+    export interface ConnectionProperties {
+      /** Your operating system */
+      os: string
+      /** Your library name */
+      browser: string
+      /** Your library name */
+      device: string
+    }
+
+    /** https://discord.com/developers/docs/topics/gateway-events#resume-resume-structure */
+    export interface Resume {
+      /** session token */
+      token: string
+      /** session id */
+      session_id: string
+      /** last sequence number received */
+      seq: integer
+    }
+
+    /** https://discord.com/developers/docs/topics/gateway-events#request-guild-members-guild-request-members-structure */
+    export interface RequestGuildMembers {
+      /** 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-events#update-voice-state-gateway-voice-state-update-structure */
+    export interface VoiceStateUpdate {
+      /** 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-events#update-presence-gateway-presence-update-structure */
+    export interface PresenceUpdate {
+      /** 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-events#gateway-events */
+export interface GatewayEvents {}
+
+/** https://discord.com/developers/docs/topics/gateway-events#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
+}
+
+/** https://discord.com/developers/docs/topics/gateway#get-gateway-example-response */
+export interface GetGatewayResponse {
+  url: string
+}
+
+/** https://discord.com/developers/docs/topics/gateway#get-gateway-bot-json-response */
+export interface GetGatewayBotResponse extends GetGatewayResponse {
+  shards: integer
+  session_start_limit: SessionStartLimit
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Returns an object with a single valid WSS URL, which the client can use for Connecting. Clients should cache this value and only call this endpoint to retrieve a new URL if they are unable to properly establish a connection using the cached version of the URL.
+     * @see https://discord.com/developers/docs/topics/gateway#get-gateway
+     */
+    getGateway(): Promise<GetGatewayResponse>
+    /**
+     * Returns an object based on the information in Get Gateway, plus additional metadata that can help during the operation of large or sharded bots. Unlike the Get Gateway, this route should not be cached for extended periods of time as the value is not guaranteed to be the same per-call, and changes as the bot joins/leaves guilds.
+     * @see https://discord.com/developers/docs/topics/gateway#get-gateway-bot
+     */
+    getGatewayBot(): Promise<GetGatewayBotResponse>
+  }
+}
+
+Internal.define({
+  '/gateway': {
+    GET: 'getGateway',
+  },
+  '/gateway/bot': {
+    GET: 'getGatewayBot',
+  },
+})

package/src/types/guild-member.ts

@@ -0,0 +1,260 @@
+import { Gateway, integer, Internal, 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
+  /** when the user's timeout will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out */
+  communication_disabled_until?: timestamp
+}
+
+export namespace GuildMember {
+  export namespace Params {
+    /** https://discord.com/developers/docs/resources/guild#list-guild-members-query-string-params */
+    export interface List {
+      /** max number of members to return (1-1000) */
+      limit?: integer
+      /** the highest user id in the previous page */
+      after?: snowflake
+    }
+
+    /** https://discord.com/developers/docs/resources/guild#search-guild-members-query-string-params */
+    export interface Search {
+      /** Query string to match username(s) and nickname(s) against. */
+      query: string
+      /** max number of members to return (1-1000) */
+      limit?: integer
+    }
+
+    /** https://discord.com/developers/docs/resources/guild#add-guild-member-json-params */
+    export interface Add {
+      /** an oauth2 access token granted with the guilds.join to the bot's application for the user you want to add to the guild */
+      access_token: string
+      /** value to set user's nickname to */
+      nick: string
+      /** array of role ids the member is assigned */
+      roles: snowflake[]
+      /** whether the user is muted in voice channels */
+      mute: boolean
+      /** whether the user is deafened in voice channels */
+      deaf: boolean
+    }
+
+    /** https://discord.com/developers/docs/resources/guild#modify-guild-member-json-params */
+    export interface Modify {
+      /** value to set user's nickname to */
+      nick: string
+      /** array of role ids the member is assigned */
+      roles: snowflake[]
+      /** whether the user is muted in voice channels. Will throw a 400 if the user is not in a voice channel */
+      mute: boolean
+      /** whether the user is deafened in voice channels. Will throw a 400 if the user is not in a voice channel */
+      deaf: boolean
+      /** id of channel to move user to (if they are connected to voice) */
+      channel_id: snowflake
+      /** when the user's timeout will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout */
+      communication_disabled_until?: timestamp
+    }
+
+    /** https://discord.com/developers/docs/resources/guild#modify-current-member-json-params */
+    export interface ModifyCurrent {
+      /** value to set user's nickname to */
+      nick?: string
+    }
+
+    /** https://discord.com/developers/docs/resources/guild#get-guild-prune-count-query-string-params */
+    export interface GetPruneCount {
+      /** number of days to count prune for (1-30) */
+      days: integer
+      /** role(s) to include */
+      include_roles: string
+    }
+
+    /** https://discord.com/developers/docs/resources/guild#begin-guild-prune-json-params */
+    export interface BeginPrune {
+      /** number of days to prune (1-30) */
+      days: integer
+      /** whether 'pruned' is returned, discouraged for large guilds */
+      compute_prune_count: boolean
+      /** role(s) to include */
+      include_roles: snowflake[]
+    }
+  }
+
+  export namespace Event {
+    /** https://discord.com/developers/docs/topics/gateway-events#guild-member-add-guild-member-add-extra-fields */
+    export interface Add extends GuildMember {
+      /** id of the guild */
+      guild_id: snowflake
+    }
+
+    /** https://discord.com/developers/docs/topics/gateway-events#guild-member-remove-guild-member-remove-event-fields */
+    export interface Remove {
+      /** the id of the guild */
+      guild_id: snowflake
+      /** the user who was removed */
+      user: User
+    }
+
+    /** https://discord.com/developers/docs/topics/gateway-events#guild-member-update-guild-member-update-event-fields */
+    export interface Update {
+      /** 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
+      /** when the user's timeout will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out */
+      communication_disabled_until?: timestamp
+    }
+
+    /** https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk-guild-members-chunk-event-fields */
+    export interface Chunk {
+      /** 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?: Gateway.Params.PresenceUpdate[]
+      /** the nonce used in the Guild Members Request */
+      nonce?: string
+    }
+  }
+}
+
+declare module './gateway' {
+  interface GatewayEvents {
+    /** new user joined a guild */
+    GUILD_MEMBER_ADD: GuildMember.Event.Add
+    /** user was removed from a guild */
+    GUILD_MEMBER_REMOVE: GuildMember.Event.Remove
+    /** guild member was updated */
+    GUILD_MEMBER_UPDATE: GuildMember.Event.Update
+    /** response to Request Guild Members */
+    GUILD_MEMBERS_CHUNK: GuildMember.Event.Chunk
+  }
+}
+
+declare module './internal' {
+  interface Internal {
+    /**
+     * Returns a guild member object for the specified user.
+     * @see https://discord.com/developers/docs/resources/guild#get-guild-member
+     */
+    getGuildMember(guild_id: snowflake, user_id: snowflake): Promise<GuildMember>
+    /**
+     * Returns a list of guild member objects that are members of the guild.
+     * @see https://discord.com/developers/docs/resources/guild#list-guild-members
+     */
+    listGuildMembers(guild_id: snowflake, params?: GuildMember.Params.List): Promise<GuildMember[]>
+    /**
+     * Returns a list of guild member objects whose username or nickname starts with a provided string.
+     * @see https://discord.com/developers/docs/resources/guild#search-guild-members
+     */
+    searchGuildMembers(guild_id: snowflake, params?: GuildMember.Params.Search): Promise<GuildMember[]>
+    /**
+     * Adds a user to the guild, provided you have a valid oauth2 access token for the user with the guilds.join scope. Returns a 201 Created with the guild member as the body, or 204 No Content if the user is already a member of the guild. Fires a Guild Member Add Gateway event.
+     * @see https://discord.com/developers/docs/resources/guild#add-guild-member
+     */
+    addGuildMember(guild_id: snowflake, user_id: snowflake, params: GuildMember.Params.Add): Promise<void>
+    /**
+     * Modify attributes of a guild member. Returns a 200 OK with the guild member as the body. Fires a Guild Member Update Gateway event. If the channel_id is set to null, this will force the target user to be disconnected from voice.
+     * @see https://discord.com/developers/docs/resources/guild#modify-guild-member
+     */
+    modifyGuildMember(guild_id: snowflake, user_id: snowflake, params: GuildMember.Params.Modify): Promise<void>
+    /**
+     * Modifies the current member in a guild. Returns a 200 with the updated member object on success. Fires a Guild Member Update Gateway event.
+     * @see https://discord.com/developers/docs/resources/guild#modify-current-member
+     */
+    modifyCurrentMember(guild_id: snowflake, params: GuildMember.Params.ModifyCurrent): Promise<void>
+    /**
+     * Adds a role to a guild member. Requires the MANAGE_ROLES permission. Returns a 204 empty response on success. Fires a Guild Member Update Gateway event.
+     * @see https://discord.com/developers/docs/resources/guild#add-guild-member-role
+     */
+    addGuildMemberRole(guild_id: snowflake, user_id: snowflake, role_id: snowflake): Promise<void>
+    /**
+     * Removes a role from a guild member. Requires the MANAGE_ROLES permission. Returns a 204 empty response on success. Fires a Guild Member Update Gateway event.
+     * @see https://discord.com/developers/docs/resources/guild#remove-guild-member-role
+     */
+    removeGuildMemberRole(guild_id: snowflake, user_id: snowflake, role_id: snowflake): Promise<void>
+    /**
+     * Remove a member from a guild. Requires KICK_MEMBERS permission. Returns a 204 empty response on success. Fires a Guild Member Remove Gateway event.
+     * @see https://discord.com/developers/docs/resources/guild#remove-guild-member
+     */
+    removeGuildMember(guild_id: snowflake, user_id: snowflake): Promise<void>
+    /**
+     * Returns an object with one 'pruned' key indicating the number of members that would be removed in a prune operation. Requires the KICK_MEMBERS permission.
+     * @see https://discord.com/developers/docs/resources/guild#get-guild-prune-count
+     */
+    getGuildPruneCount(guild_id: snowflake, params?: GuildMember.Params.GetPruneCount): Promise<void>
+    /**
+     * Begin a prune operation. Requires the KICK_MEMBERS permission. Returns an object with one 'pruned' key indicating the number of members that were removed in the prune operation. For large guilds it's recommended to set the compute_prune_count option to false, forcing 'pruned' to null. Fires multiple Guild Member Remove Gateway events.
+     * @see https://discord.com/developers/docs/resources/guild#begin-guild-prune
+     */
+    beginGuildPrune(guild_id: snowflake, params: GuildMember.Params.BeginPrune): Promise<void>
+  }
+}
+
+Internal.define({
+  '/guilds/{guild.id}/members/{user.id}': {
+    GET: 'getGuildMember',
+    PUT: 'addGuildMember',
+    PATCH: 'modifyGuildMember',
+    DELETE: 'removeGuildMember',
+  },
+  '/guilds/{guild.id}/members': {
+    GET: 'listGuildMembers',
+  },
+  '/guilds/{guild.id}/members/search': {
+    GET: 'searchGuildMembers',
+  },
+  '/guilds/{guild.id}/members/@me': {
+    PATCH: 'modifyCurrentMember',
+  },
+  '/guilds/{guild.id}/members/{user.id}/roles/{role.id}': {
+    PUT: 'addGuildMemberRole',
+    DELETE: 'removeGuildMemberRole',
+  },
+  '/guilds/{guild.id}/prune': {
+    GET: 'getGuildPruneCount',
+    POST: 'beginGuildPrune',
+  },
+})