pkgs/gateway/src/types.ts (view raw)
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 |
import type {
UserResponse,
GuildResponse,
GuildChannelResponse,
ThreadMemberResponse,
GuildMemberResponse,
EmojiResponse,
GuildStickerResponse,
AuditLogEntryResponse,
EntitlementResponse,
VoiceStateResponse,
StageInstanceResponse,
MessageResponse,
InteractionResponse,
DiscordIntegrationResponse,
ScheduledEventResponse,
GuildRoleResponse,
Snowflake,
} from "@purrkit/types";
export enum OpCodes {
/** Fired periodically by the client to keep the connection alive. */
Dispatch = 0,
/** Starts a new session during the initial handshake. */
Heartbeat = 1,
/** Starts a new session during the initial handshake. */
Identify = 2,
/** Update the client’s presence. */
PresenceUpdate = 3,
/** Used to join/leave or move between voice channels. */
VoiceStateUpdate = 4,
/** Resume a previous session that was disconnected. */
Resume = 6,
/** You should attempt to reconnect and resume immediately. */
Reconnect = 7,
/** Request information about offline GuildResponse members in a large GuildResponse. */
RequestGuildMemberResponses = 8,
/** The session has been invalidated. You should reconnect and identify/resume accordingly. */
InvalidSession = 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. */
HeartbeatAck = 11,
/** Request information about soundboard sounds in a set of guilds. */
RequestSoundboardSounds = 31,
/** Request ephemeral channel data for channels in a GuildResponse. */
RequestChannelInfo = 43,
}
export type APIGuildUnavailable = {
id: Snowflake;
unavailable: boolean;
};
export interface GatewayEvents {
READY: GatewayReadyDispatchData;
RESUMED: Record<string, never>;
APPLICATION_COMMAND_PERMISSIONS_UPDATE: GatewayApplicationCommandPermissionsUpdateDispatchData;
AUTO_MODERATION_RULE_CREATE: GatewayAutoModerationRuleCreateDispatchData;
AUTO_MODERATION_RULE_UPDATE: GatewayAutoModerationRuleUpdateDispatchData;
AUTO_MODERATION_RULE_DELETE: GatewayAutoModerationRuleDeleteDispatchData;
AUTO_MODERATION_ACTION_EXECUTION: GatewayAutoModerationActionExecutionDispatchData;
CHANNEL_CREATE: GatewayChannelCreateDispatchData;
CHANNEL_UPDATE: GatewayChannelUpdateDispatchData;
CHANNEL_DELETE: GatewayChannelDeleteDispatchData;
CHANNEL_PINS_UPDATE: GatewayChannelPinsUpdateDispatchData;
THREAD_CREATE: GatewayThreadCreateDispatchData;
THREAD_UPDATE: GatewayThreadUpdateDispatchData;
THREAD_DELETE: GatewayThreadDeleteDispatchData;
THREAD_LIST_SYNC: GatewayThreadListSyncDispatchData;
THREAD_MEMBER_UPDATE: GatewayThreadMemberUpdateDispatchData;
THREAD_MEMBERS_UPDATE: GatewayThreadMembersUpdateDispatchData;
GUILD_CREATE: GatewayGuildCreateDispatchData;
GUILD_UPDATE: GatewayGuildUpdateDispatchData;
GUILD_DELETE: GatewayGuildDeleteDispatchData;
GUILD_AUDIT_LOG_ENTRY_CREATE: GatewayGuildAuditLogEntryCreateDispatchData;
GUILD_BAN_ADD: GatewayGuildBanAddDispatchData;
GUILD_BAN_REMOVE: GatewayGuildBanRemoveDispatchData;
GUILD_EMOJIS_UPDATE: GatewayGuildEmojisUpdateDispatchData;
GUILD_STICKERS_UPDATE: GatewayGuildStickersUpdateDispatchData;
GUILD_INTEGRATIONS_UPDATE: GatewayGuildIntegrationsUpdateDispatchData;
GUILD_MEMBER_ADD: GatewayGuildMemberResponseAddDispatchData;
GUILD_MEMBER_REMOVE: GatewayGuildMemberResponseRemoveDispatchData;
GUILD_MEMBER_UPDATE: GatewayGuildMemberResponseUpdateDispatchData;
GUILD_MEMBERS_CHUNK: GatewayGuildMemberResponsesChunkDispatchData;
GUILD_ROLE_CREATE: GatewayGuildRoleCreateDispatchData;
GUILD_ROLE_UPDATE: GatewayGuildRoleUpdateDispatchData;
GUILD_ROLE_DELETE: GatewayGuildRoleDeleteDispatchData;
GUILD_SCHEDULED_EVENT_CREATE: GatewayGuildScheduledEventCreateDispatchData;
GUILD_SCHEDULED_EVENT_UPDATE: GatewayGuildScheduledEventUpdateDispatchData;
GUILD_SCHEDULED_EVENT_DELETE: GatewayGuildScheduledEventDeleteDispatchData;
GUILD_SCHEDULED_EVENT_USER_ADD: GatewayGuildScheduledEventUserAddDispatchData;
GUILD_SCHEDULED_EVENT_USER_REMOVE: GatewayGuildScheduledEventUserRemoveDispatchData;
INTEGRATION_CREATE: GatewayIntegrationCreateDispatchData;
INTEGRATION_UPDATE: GatewayIntegrationUpdateDispatchData;
INTEGRATION_DELETE: GatewayIntegrationDeleteDispatchData;
INTERACTION_CREATE: GatewayInteractionCreateDispatchData;
INVITE_CREATE: GatewayInviteCreateDispatchData;
INVITE_DELETE: GatewayInviteDeleteDispatchData;
MESSAGE_CREATE: GatewayMessageCreateDispatchData;
MESSAGE_UPDATE: GatewayMessageUpdateDispatchData;
MESSAGE_DELETE: GatewayMessageDeleteDispatchData;
MESSAGE_DELETE_BULK: GatewayMessageDeleteBulkDispatchData;
MESSAGE_REACTION_ADD: GatewayMessageReactionAddDispatchData;
MESSAGE_REACTION_REMOVE: GatewayMessageReactionRemoveDispatchData;
MESSAGE_REACTION_REMOVE_ALL: GatewayMessageReactionRemoveAllDispatchData;
MESSAGE_REACTION_REMOVE_EMOJI: GatewayMessageReactionRemoveEmojiDispatchData;
PRESENCE_UPDATE: GatewayPresenceUpdateDispatchData;
STAGE_INSTANCE_CREATE: GatewayStageInstanceCreateDispatchData;
STAGE_INSTANCE_UPDATE: GatewayStageInstanceUpdateDispatchData;
STAGE_INSTANCE_DELETE: GatewayStageInstanceDeleteDispatchData;
TYPING_START: GatewayTypingStartDispatchData;
USER_UPDATE: GatewayUserUpdateDispatchData;
VOICE_STATE_UPDATE: GatewayVoiceStateUpdateDispatchData;
VOICE_SERVER_UPDATE: GatewayVoiceServerUpdateDispatchData;
WEBHOOKS_UPDATE: GatewayWebhooksUpdateDispatchData;
ENTITLEMENT_CREATE: GatewayEntitlementCreateDispatchData;
ENTITLEMENT_UPDATE: GatewayEntitlementUpdateDispatchData;
ENTITLEMENT_DELETE: GatewayEntitlementDeleteDispatchData;
}
export interface GatewayReadyDispatchData {
v: number;
user: UserResponse;
guilds: APIGuildUnavailable[];
session_id: string;
resume_gateway_url: string;
shard?: [shard_id: number, num_shards: number];
application: { id: Snowflake; flags: number };
}
export interface GatewayApplicationCommandPermissionsUpdateDispatchData {
id: Snowflake;
application_id: Snowflake;
guild_id: Snowflake;
permissions: {
id: Snowflake;
type: number; // 1 = ROLE, 2 = USER, 3 = CHANNEL
permission: boolean;
}[];
}
// TOOD)) types for below
export type GatewayAutoModerationRuleCreateDispatchData = unknown;
export type GatewayAutoModerationRuleUpdateDispatchData = unknown;
export type GatewayAutoModerationRuleDeleteDispatchData = unknown;
export interface GatewayAutoModerationActionExecutionDispatchData {
guild_id: Snowflake;
action: {
type: number;
metadata?: any;
};
rule_id: Snowflake;
rule_trigger_type: number;
user_id: Snowflake;
channel_id?: Snowflake;
message_id?: Snowflake;
alert_system_message_id?: Snowflake;
content: string;
matched_keyword: string | null;
matched_content: string | null;
}
export type GatewayChannelCreateDispatchData = GuildChannelResponse;
export type GatewayChannelUpdateDispatchData = GuildChannelResponse;
export type GatewayChannelDeleteDispatchData = GuildChannelResponse;
export interface GatewayChannelPinsUpdateDispatchData {
guild_id?: Snowflake;
channel_id: Snowflake;
last_pin_timestamp?: string | null;
}
export interface GatewayThreadCreateDispatchData extends GuildChannelResponse {
newly_created?: boolean;
thread_member?: ThreadMemberResponse;
}
export type GatewayThreadUpdateDispatchData = GuildChannelResponse;
export interface GatewayThreadDeleteDispatchData {
id: Snowflake;
guild_id: Snowflake;
parent_id: Snowflake;
type: number;
}
export interface GatewayThreadListSyncDispatchData {
guild_id: Snowflake;
channel_ids?: Snowflake[];
threads: GuildChannelResponse[];
members: ThreadMemberResponse[];
}
export interface GatewayThreadMemberUpdateDispatchData extends ThreadMemberResponse {
guild_id: Snowflake;
}
export interface GatewayThreadMembersUpdateDispatchData {
id: Snowflake;
guild_id: Snowflake;
member_count: number;
added_members?: ThreadMemberResponse[];
removed_member_ids?: Snowflake[];
}
export interface GatewayGuildCreateDispatchData extends GuildResponse {
joined_at?: string;
large?: boolean;
unavailable?: boolean;
member_count?: number;
voice_states?: Omit<VoiceStateResponse, "guild_id">[];
members?: GuildMemberResponse[];
channels?: GuildChannelResponse[];
threads?: GuildChannelResponse[];
presences?: GatewayPresenceUpdateDispatchData[];
stage_instances?: StageInstanceResponse[];
guild_scheduled_events?: ScheduledEventResponse[];
}
export type GatewayGuildUpdateDispatchData = GuildResponse;
export interface GatewayGuildDeleteDispatchData {
id: Snowflake;
unavailable?: boolean;
}
export type GatewayGuildAuditLogEntryCreateDispatchData = AuditLogEntryResponse;
export interface GatewayGuildBanAddDispatchData {
guild_id: Snowflake;
user: UserResponse;
}
export interface GatewayGuildBanRemoveDispatchData {
guild_id: Snowflake;
user: UserResponse;
}
export interface GatewayGuildEmojisUpdateDispatchData {
guild_id: Snowflake;
emojis: EmojiResponse[];
}
export interface GatewayGuildStickersUpdateDispatchData {
guild_id: Snowflake;
stickers: GuildStickerResponse[];
}
export interface GatewayGuildIntegrationsUpdateDispatchData {
guild_id: Snowflake;
}
export interface GatewayGuildMemberResponseAddDispatchData extends GuildMemberResponse {
guild_id: Snowflake;
}
export interface GatewayGuildMemberResponseRemoveDispatchData {
guild_id: Snowflake;
user: UserResponse;
}
export interface GatewayGuildMemberResponseUpdateDispatchData {
guild_id: Snowflake;
roles: Snowflake[];
user: UserResponse;
avatar: string | null;
joined_at: string | null;
premium_since?: string | null;
deaf?: boolean;
mute?: boolean;
pending?: boolean;
communication_disabled_until?: string | null;
}
export interface GatewayGuildMemberResponsesChunkDispatchData {
guild_id: Snowflake;
members: GuildMemberResponse[];
chunk_index: number;
chunk_count: number;
not_found?: Snowflake[];
presences?: GatewayPresenceUpdateDispatchData[];
nonce?: string;
}
export interface GatewayGuildRoleCreateDispatchData {
guild_id: Snowflake;
role: GuildRoleResponse;
}
export interface GatewayGuildRoleUpdateDispatchData {
guild_id: Snowflake;
role: GuildRoleResponse;
}
export interface GatewayGuildRoleDeleteDispatchData {
guild_id: Snowflake;
role_id: Snowflake;
}
export type GatewayGuildScheduledEventCreateDispatchData = ScheduledEventResponse;
export type GatewayGuildScheduledEventUpdateDispatchData = ScheduledEventResponse;
export type GatewayGuildScheduledEventDeleteDispatchData = ScheduledEventResponse;
export interface GatewayGuildScheduledEventUserAddDispatchData {
guild_scheduled_event_id: Snowflake;
user_id: Snowflake;
guild_id: Snowflake;
}
export interface GatewayGuildScheduledEventUserRemoveDispatchData {
guild_scheduled_event_id: Snowflake;
user_id: Snowflake;
guild_id: Snowflake;
}
export interface GatewayIntegrationCreateDispatchData extends DiscordIntegrationResponse {
guild_id: Snowflake;
}
export interface GatewayIntegrationUpdateDispatchData extends DiscordIntegrationResponse {
guild_id: Snowflake;
}
export interface GatewayIntegrationDeleteDispatchData {
id: Snowflake;
guild_id: Snowflake;
application_id?: Snowflake;
}
export type GatewayInteractionCreateDispatchData = InteractionResponse;
export interface GatewayInviteCreateDispatchData {
channel_id: Snowflake;
code: string;
created_at: string;
guild_id?: Snowflake;
inviter?: UserResponse;
max_age: number;
max_uses: number;
temporary: boolean;
uses: number;
target_type?: number;
target_user?: UserResponse;
target_application?: any;
}
export interface GatewayInviteDeleteDispatchData {
channel_id: Snowflake;
guild_id?: Snowflake;
code: string;
}
export type GatewayMessageCreateDispatchData = MessageResponse;
export interface GatewayMessageUpdateDispatchData extends Partial<MessageResponse> {
id: Snowflake;
channel_id: Snowflake;
}
export interface GatewayMessageDeleteDispatchData {
id: Snowflake;
channel_id: Snowflake;
guild_id?: Snowflake;
}
export interface GatewayMessageDeleteBulkDispatchData {
ids: Snowflake[];
channel_id: Snowflake;
guild_id?: Snowflake;
}
export interface GatewayMessageReactionAddDispatchData {
user_id: Snowflake;
channel_id: Snowflake;
message_id: Snowflake;
guild_id?: Snowflake;
member?: GuildMemberResponse;
emoji: EmojiResponse;
message_author_id?: Snowflake;
}
export interface GatewayMessageReactionRemoveDispatchData {
user_id: Snowflake;
channel_id: Snowflake;
message_id: Snowflake;
guild_id?: Snowflake;
emoji: EmojiResponse;
}
export interface GatewayMessageReactionRemoveAllDispatchData {
channel_id: Snowflake;
message_id: Snowflake;
guild_id?: Snowflake;
}
export interface GatewayMessageReactionRemoveEmojiDispatchData {
channel_id: Snowflake;
message_id: Snowflake;
guild_id?: Snowflake;
emoji: EmojiResponse;
}
export interface GatewayPresenceUpdateDispatchData {
user: Partial<UserResponse> & { id: Snowflake };
guild_id?: Snowflake;
status: "online" | "dnd" | "idle" | "invisible" | "offline";
activities: any[];
client_status: {
desktop?: string;
mobile?: string;
web?: string;
};
}
export type GatewayStageInstanceCreateDispatchData = StageInstanceResponse;
export type GatewayStageInstanceUpdateDispatchData = StageInstanceResponse;
export type GatewayStageInstanceDeleteDispatchData = StageInstanceResponse;
export interface GatewayTypingStartDispatchData {
channel_id: Snowflake;
guild_id?: Snowflake;
user_id: Snowflake;
timestamp: number;
member?: GuildMemberResponse;
}
export type GatewayUserUpdateDispatchData = UserResponse;
export type GatewayVoiceStateUpdateDispatchData = VoiceStateResponse;
export interface GatewayVoiceServerUpdateDispatchData {
token: string;
guild_id: Snowflake;
endpoint: string | null;
}
export interface GatewayWebhooksUpdateDispatchData {
guild_id: Snowflake;
channel_id: Snowflake;
}
export type GatewayEntitlementCreateDispatchData = EntitlementResponse;
export type GatewayEntitlementUpdateDispatchData = EntitlementResponse;
export type GatewayEntitlementDeleteDispatchData = EntitlementResponse;
|