123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
/** * Types extracted from https://discord.com/developers/docs/topics/gateway */
import type { APIChannel, APIThreadMember } from './channel.ts';import type { APIEmoji } from './emoji.ts';import type { APIUser } from './user.ts';import type { Snowflake } from '../../globals.ts';
/** * https://discord.com/developers/docs/topics/gateway#get-gateway */export interface APIGatewayInfo {	/**	 * The WSS URL that can be used for connecting to the gateway	 */	url: string;}
/** * https://discord.com/developers/docs/topics/gateway#get-gateway-bot */export interface APIGatewayBotInfo extends APIGatewayInfo {	/**	 * The recommended number of shards to use when connecting	 *	 * See https://discord.com/developers/docs/topics/gateway#sharding	 */	shards: number;	/**	 * Information on the current session start limit	 *	 * See https://discord.com/developers/docs/topics/gateway#session-start-limit-object	 */	session_start_limit: APIGatewaySessionStartLimit;}
/** * https://discord.com/developers/docs/topics/gateway#session-start-limit-object */export interface APIGatewaySessionStartLimit {	/**	 * The total number of session starts the current user is allowed	 */	total: number;	/**	 * The remaining number of session starts the current user is allowed	 */	remaining: number;	/**	 * The number of milliseconds after which the limit resets	 */	reset_after: number;	/**	 * The number of identify requests allowed per 5 seconds	 */	max_concurrency: number;}
/** * https://discord.com/developers/docs/topics/gateway#presence-update-presence-update-event-fields */export interface GatewayPresenceUpdate {	/**	 * The user presence is being updated for	 *	 * **The user object within this event can be partial, the only field which must be sent is the `id` field,	 * everything else is optional.**	 *	 * See https://discord.com/developers/docs/resources/user#user-object	 */	user: Partial<APIUser> & Pick<APIUser, 'id'>;	/**	 * ID of the guild	 */	guild_id: Snowflake;	/**	 * Either "idle", "dnd", "online", or "offline"	 */	status?: PresenceUpdateStatus;	/**	 * User's current activities	 *	 * See https://discord.com/developers/docs/topics/gateway#activity-object	 */	activities?: GatewayActivity[];	/**	 * User's platform-dependent status	 *	 * See https://discord.com/developers/docs/topics/gateway#client-status-object	 */	client_status?: GatewayPresenceClientStatus;}
export enum PresenceUpdateStatus {	Online = 'online',	DoNotDisturb = 'dnd',	Idle = 'idle',	/**	 * Invisible and shown as offline	 */	Invisible = 'invisible',	Offline = 'offline',}
/** * https://discord.com/developers/docs/topics/gateway#client-status-object */export interface GatewayPresenceClientStatus {	/**	 * The user's status set for an active desktop (Windows, Linux, Mac) application session	 */	desktop?: PresenceUpdateStatus;	/**	 * The user's status set for an active mobile (iOS, Android) application session	 */	mobile?: PresenceUpdateStatus;	/**	 * The user's status set for an active web (browser, bot account) application session	 */	web?: PresenceUpdateStatus;}
/** * https://discord.com/developers/docs/topics/gateway#activity-object-activity-structure */export interface GatewayActivity {	/**	 * The activity's id	 */	id: string;	/**	 * The activity's name	 */	name: string;	/**	 * Activity type	 *	 * See https://discord.com/developers/docs/topics/gateway#activity-object-activity-types	 */	type: ActivityType;	/**	 * Stream url, is validated when type is `1`	 */	url?: string | null;	/**	 * Unix timestamp of when the activity was added to the user's session	 */	created_at: number;	/**	 * Unix timestamps for start and/or end of the game	 */	timestamps?: GatewayActivityTimestamps;	sync_id?: string;	/**	 * {@link ActivityPlatform}	 */	platform?: string;	/**	 * Application id for the game	 */	application_id?: Snowflake;	/**	 * What the player is currently doing	 */	details?: string | null;	/**	 * The user's current party status	 */	state?: string | null;	/**	 * The emoji used for a custom status	 *	 * See https://discord.com/developers/docs/topics/gateway#activity-object-activity-emoji	 */	emoji?: GatewayActivityEmoji;	session_id?: string;	/**	 * Information for the current party of the player	 *	 * See https://discord.com/developers/docs/topics/gateway#activity-object-activity-party	 */	party?: GatewayActivityParty;	/**	 * Images for the presence and their hover texts	 *	 * See https://discord.com/developers/docs/topics/gateway#activity-object-activity-assets	 */	assets?: GatewayActivityAssets;	/**	 * Secrets for Rich Presence joining and spectating	 *	 * See https://discord.com/developers/docs/topics/gateway#activity-object-activity-secrets	 */	secrets?: GatewayActivitySecrets;	/**	 * Whether or not the activity is an instanced game session	 */	instance?: boolean;	/**	 * Activity flags `OR`d together, describes what the payload includes	 *	 * See https://discord.com/developers/docs/topics/gateway#activity-object-activity-flags	 *	 * See https://en.wikipedia.org/wiki/Bit_field	 */	flags?: ActivityFlags;	/**	 * The custom buttons shown in the Rich Presence (max 2)	 */	buttons?: string[] | GatewayActivityButton[];}
/** * @unstable This enum is currently not documented by Discord but has known values which we will try to keep up to date. * Values might be added or removed without a major version bump. */export enum ActivityPlatform {	Desktop = 'desktop',	Xbox = 'xbox',	Samsung = 'samsung',	IOS = 'ios',	Android = 'android',	Embedded = 'embedded',	PS4 = 'ps4',	PS5 = 'ps5',}
/** * https://discord.com/developers/docs/topics/gateway#activity-object-activity-types */export enum ActivityType {	/**	 * Playing {game}	 */	Playing,	/**	 * Streaming {details}	 */	Streaming,	/**	 * Listening to {name}	 */	Listening,	/**	 * Watching {details}	 */	Watching,	/**	 * {emoji} {details}	 */	Custom,	/**	 * Competing in {name}	 */	Competing,}
/** * https://discord.com/developers/docs/topics/gateway#activity-object-activity-timestamps */export interface GatewayActivityTimestamps {	/**	 * Unix time (in milliseconds) of when the activity started	 */	start?: number;	/**	 * Unix time (in milliseconds) of when the activity ends	 */	end?: number;}
/** * https://discord.com/developers/docs/topics/gateway#activity-object-activity-emoji */export type GatewayActivityEmoji = Partial<Pick<APIEmoji, 'id' | 'animated'>> & Pick<APIEmoji, 'name'>;
/** * https://discord.com/developers/docs/topics/gateway#activity-object-activity-party */export interface GatewayActivityParty {	/**	 * The id of the party	 */	id?: string;	/**	 * Used to show the party's current and maximum size	 */	size?: [current_size: number, max_size: number];}
/** * https://discord.com/developers/docs/topics/gateway#activity-object-activity-assets */export type GatewayActivityAssets = Partial<	Record<'large_image' | 'large_text' | 'small_image' | 'small_text', string>>;
/** * https://discord.com/developers/docs/topics/gateway#activity-object-activity-secrets */export type GatewayActivitySecrets = Partial<Record<'join' | 'spectate' | 'match', string>>;
/** * https://discord.com/developers/docs/topics/gateway#activity-object-activity-flags */export enum ActivityFlags {	Instance = 1 << 0,	Join = 1 << 1,	Spectate = 1 << 2,	JoinRequest = 1 << 3,	Sync = 1 << 4,	Play = 1 << 5,	PartyPrivacyFriends = 1 << 6,	PartyPrivacyVoiceChannel = 1 << 7,	Embedded = 1 << 8,}
export interface GatewayActivityButton {	/**	 * The text shown on the button (1-32 characters)	 */	label: string;	/**	 * The url opened when clicking the button (1-512 characters)	 */	url: string;}
/** * https://discord.com/developers/docs/topics/gateway#thread-list-sync-thread-list-sync-event-fields */export interface GatewayThreadListSync {	/**	 * ID of the guild	 */	guild_id: Snowflake;	/**	 * The ids of all the parent channels whose threads are being synced, otherwise the entire guild	 */	channel_ids?: Snowflake[];	/**	 * Array of the synced threads	 */	threads: APIChannel[];	/**	 * The member objects for the client user in each joined thread that was synced	 */	members: APIThreadMember[];}
/** * https://discord.com/developers/docs/topics/gateway#thread-members-update-thread-members-update-event-fields */export interface GatewayThreadMembersUpdate {	/**	 * The id of the thread for which members are being synced	 */	id: Snowflake;	/**	 * The id of the guild that the thread is in	 */	guild_id: Snowflake;	/**	 * The approximate member count of the thread, does not count above 50 even if there are more members	 */	member_count: number;	/**	 * The members that were added to the thread	 */	added_members?: APIThreadMember[];	/**	 * The ids of the members that were removed from the thread	 */	removed_member_ids?: Snowflake[];}