Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Interface to associate GatewayDispatchEvents and relevant DataPayload (proposed code below) #617

Closed
john-batch opened this issue Oct 21, 2022 · 5 comments · Fixed by #619
Closed

Interface to associate GatewayDispatchEvents and relevant DataPayload (proposed code below) #617

john-batch opened this issue Oct 21, 2022 · 5 comments · Fixed by #619

Comments

@john-batch
Copy link
Contributor

john-batch commented Oct 21, 2022 •
edited

Feature

A good addition would be an interface to associate a GatewayDispatchEvents event with the relevant DataPayload dispatched along this event.

Ideal solution or implementation

The following interface only works for V10 :

interface GatewayDispatchData {
	[GatewayDispatchEvents.ChannelCreate]: GatewayChannelModifyDispatchData
	[GatewayDispatchEvents.ChannelDelete]: GatewayChannelModifyDispatchData
	[GatewayDispatchEvents.ChannelPinsUpdate]: GatewayChannelPinsUpdateDispatchData
	[GatewayDispatchEvents.ChannelUpdate]: GatewayChannelModifyDispatchData
	[GatewayDispatchEvents.GuildBanAdd]: GatewayGuildBanModifyDispatchData
	[GatewayDispatchEvents.GuildBanRemove]: GatewayGuildBanModifyDispatchData
	[GatewayDispatchEvents.GuildCreate]: GatewayGuildCreateDispatchData
	[GatewayDispatchEvents.GuildDelete]: GatewayGuildDeleteDispatchData
	[GatewayDispatchEvents.GuildEmojisUpdate]: GatewayGuildEmojisUpdateDispatchData
	[GatewayDispatchEvents.GuildIntegrationsUpdate]: GatewayGuildIntegrationsUpdateDispatchData
	[GatewayDispatchEvents.GuildMemberAdd]: GatewayGuildMemberAddDispatchData
	[GatewayDispatchEvents.GuildMemberRemove]: GatewayGuildMemberRemoveDispatchData
	[GatewayDispatchEvents.GuildMembersChunk]: GatewayGuildMembersChunkDispatchData
	[GatewayDispatchEvents.GuildMemberUpdate]: GatewayGuildMemberUpdateDispatchData
	[GatewayDispatchEvents.GuildRoleCreate]: GatewayGuildRoleModifyDispatchData
	[GatewayDispatchEvents.GuildRoleDelete]: GatewayGuildRoleDeleteDispatchData
	[GatewayDispatchEvents.GuildRoleUpdate]: GatewayChannelModifyDispatchData
	[GatewayDispatchEvents.GuildScheduledEventCreate]: GatewayGuildScheduledEventCreateDispatchData
	[GatewayDispatchEvents.GuildScheduledEventDelete]: GatewayGuildScheduledEventDeleteDispatchData
	[GatewayDispatchEvents.GuildScheduledEventUpdate]: GatewayGuildScheduledEventUpdateDispatchData
	[GatewayDispatchEvents.GuildScheduledEventUserAdd]: GatewayGuildScheduledEventUserAddDispatchData
	[GatewayDispatchEvents.GuildScheduledEventUserRemove]: GatewayGuildScheduledEventUserAddDispatchData
	[GatewayDispatchEvents.GuildStickersUpdate]: GatewayGuildStickersUpdateDispatchData
	[GatewayDispatchEvents.GuildUpdate]: GatewayGuildModifyDispatchData
	[GatewayDispatchEvents.IntegrationCreate]: GatewayIntegrationCreateDispatchData
	[GatewayDispatchEvents.IntegrationDelete]: GatewayIntegrationDeleteDispatchData
	[GatewayDispatchEvents.IntegrationUpdate]: GatewayIntegrationUpdateDispatchData
	[GatewayDispatchEvents.InteractionCreate]: GatewayInteractionCreateDispatchData
	[GatewayDispatchEvents.InviteCreate]: GatewayInviteCreateDispatchData
	[GatewayDispatchEvents.InviteDelete]: GatewayInviteDeleteDispatchData
	[GatewayDispatchEvents.MessageCreate]: GatewayMessageCreateDispatchData
	[GatewayDispatchEvents.MessageDelete]: GatewayMessageDeleteDispatchData
	[GatewayDispatchEvents.MessageDeleteBulk]: GatewayMessageDeleteBulkDispatchData
	[GatewayDispatchEvents.MessageReactionAdd]: GatewayMessageReactionAddDispatchData
	[GatewayDispatchEvents.MessageReactionRemove]: GatewayMessageReactionRemoveDispatchData
	[GatewayDispatchEvents.MessageReactionRemoveAll]: GatewayMessageReactionRemoveAllDispatchData
	[GatewayDispatchEvents.MessageReactionRemoveEmoji]: GatewayMessageReactionRemoveEmojiDispatchData
	[GatewayDispatchEvents.MessageUpdate]: GatewayMessageUpdateDispatchData
	[GatewayDispatchEvents.PresenceUpdate]: GatewayPresenceUpdateDispatchData
	[GatewayDispatchEvents.Ready]: GatewayReadyDispatchData
	[GatewayDispatchEvents.Resumed]: never
	[GatewayDispatchEvents.StageInstanceCreate]: GatewayStageInstanceCreateDispatchData
	[GatewayDispatchEvents.StageInstanceDelete]: GatewayStageInstanceDeleteDispatchData
	[GatewayDispatchEvents.StageInstanceUpdate]: GatewayStageInstanceUpdateDispatchData
	[GatewayDispatchEvents.ThreadCreate]: GatewayChannelModifyDispatchData
	[GatewayDispatchEvents.ThreadDelete]: GatewayChannelModifyDispatchData
	[GatewayDispatchEvents.ThreadListSync]: GatewayThreadListSyncDispatchData
	[GatewayDispatchEvents.ThreadMembersUpdate]: GatewayThreadMembersUpdateDispatchData
	[GatewayDispatchEvents.ThreadMemberUpdate]: GatewayThreadMemberUpdateDispatchData
	[GatewayDispatchEvents.ThreadUpdate]: GatewayChannelModifyDispatchData
	[GatewayDispatchEvents.TypingStart]: GatewayTypingStartDispatchData
	[GatewayDispatchEvents.UserUpdate]: GatewayUserUpdateDispatchData
	[GatewayDispatchEvents.VoiceServerUpdate]: GatewayVoiceServerUpdateDispatchData
	[GatewayDispatchEvents.VoiceStateUpdate]: GatewayVoiceStateUpdateDispatchData
	[GatewayDispatchEvents.WebhooksUpdate]: GatewayWebhooksUpdateDispatchData
}

Alternative solutions or implementations

type _Payload = {
	[E in GatewayDispatchEvents]: GatewayDispatchPayload & { t: E }
}

type GatewayDispatchData = {
	[E in keyof _Payload]: "d" extends keyof _Payload[E] ? _Payload[E]["d"] : never
}

Other context

No response
@didinele
Copy link
Member

didinele commented Oct 21, 2022 •
edited

I've actually had the need for this myself and simply hacked it up:

import type { GatewayDispatchEvents, GatewayDispatchPayload, GatewaySendPayload } from 'discord-api-types/v10';

type _DiscordEventsMap = {
	[K in GatewayDispatchEvents]: GatewayDispatchPayload & {
		t: K;
	};
};

export type DiscordEventsMap = {
	// @ts-expect-error
	[K in keyof _DiscordEventsMap]: _DiscordEventsMap[K]['d'];
} & {
	send: GatewaySendPayload;
};

It doesn't play nicely with TSC, given the needed @ts-expect-error (as of about TS 4.8) and the fact that it needs two types (you'd think you could just inline the first one, but it does not behave the same way), but it gets the job done.

@john-batch
Copy link
Contributor Author

The reason your hack requires @ts-expect-error is because some events don't have an associated payload (like ApplicationCommandPermissionsUpdate). You can fix it like this :

type _Payload = {
	[E in GatewayDispatchEvents]: GatewayDispatchPayload & { t: E }
}

type GatewayDispatchData = {
	[E in keyof _Payload]: "d" extends keyof _Payload[E] ? _Payload[E]["d"] : never
}

I edited my original post to include it as an alternative implementation.

@didinele
Copy link
Member

Good catch! That explains why it only recently started occurring, thanks.

@vladfrangu
Copy link
Member

Thats quite a big issue if there's events without associated payloads... PRs are more than welcome!!

@john-batch
Copy link
Contributor Author

john-batch commented Oct 21, 2022 •
edited

Thats quite a big issue if there's events without associated payloads... PRs are more than welcome!!

Done. (#619)

@vladfrangu vladfrangu mentioned this issue Oct 22, 2022
Merged
@kyranet kyranet linked a pull request Oct 23, 2022 that will close this issue
fix: add missing gateway dispatch payloads to gateway event union #619
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: add missing gateway dispatch payloads to gateway event union
3 participants
@vladfrangu @didinele @john-batch