fix(Typings): type attachments to InteractionUpdateOptions

[Milo123459]

Please describe the changes this PR makes and why it should be merged:

Currently, if you want to remove attachments from a message you have to use message.removeAttachments(), and if you need to edit the content as well that is 2 API calls. Assigning attachments: [] does work, but sparks errors in TypeScript that require // @ts-ignore - which is generally considered a bad practice. This PR fixes the typings allowing you to assign attachments: [] without having to use ts-ignore.

Status and versioning classification:

I know how to update typings and have done so, or typings don't need updating

[DTrombett]

const attachments: MessageAttachment[] = [];
msg.edit({ attachments, content: 'abc' });

This works without using TS ignore...

[Milo123459]

If that works then logically speaking I would expect attachments: [] as MessageAttachment[] to work but I still get the same error if I just gave it a blank array

[Milo123459]

Also, this error also pops up when using <MessageComponentInteraction>.update({attachments: []}) - I can't seem to find an interface that corrosponds to the attachments field. It's all just chains of Omit's

[monbrey]

I can't replicate any issue with message.edit({ attachments: [] }), TypeScript isnt complaining.

[Milo123459]

Odd. I also get this error when trying to update a MesaageComponentInteraction with no attachments.

[monbrey]

attachments is not a valid property for InteractionUpdateOptions. We briefly discussed this in dev chats but never applied a fix. Ignoring the Omit typings, it's basically a chain.

InteractionUpdateOptions > InteractionReplyOptions > WebhookMessageOptions > MessageOptions

This isn't quite what it should be; InteractionUpdateOptions should probably be something more like:

export interface InteractionUpdateOptions extends Omit<WebhookEditMessageOptions, 'username' | 'avatarURL'> {
  fetchReply?: boolean;
}

and WebhookEditMessageOptions probably needs to support editing attachments, so:

export interface WebhookEditMessageOptions extends Pick<
  WebhookMessageOptions,
  'content' | 'embeds' | 'files' | 'allowedMentions' | 'components'
> {
  attachments: MessageAttachment[];
}

Or just scrap picking from WebookMessageOptions and pick from MessageEditOptions instead?

[Milo123459]

Picking from MessageOptions makes more sense. I'll try to implement a fix.

[Milo123459]

export interface WebhookEditMessageOptions extends Pick<
  WebhookMessageOptions,
  'content' | 'embeds' | 'files' | 'allowedMentions' | 'components'
> {
  attachments: MessageAttachment[];
}

From what you said, this implies that when you are assigning attachments it'll cause the same error this is PR trying to fix. I'll go with attachments: (MessageAttachment | never)[] as that's what this PR is fixing.

[monbrey]

You're referring to an error I was unable to replicate on message.edit. I don't believe typing it as never is the correct fix for the issue you described, which does exist on interaction.update as no typings for attachments exist as all.

For comparison, you can also remove components and embeds by setting those to empty arrays, and those don't have never typings. It's not the right fix.

[Milo123459]

So all this has to do is type attachments for InteractionUpdateOptions?

[monbrey]

So all this has to do is type attachments for InteractionUpdateOptions?

I think so, yes. But as its a long chain of Omits as you pointed out, finding the right place/editing that chain is the tricky part.

Otherwise if you are running into the issue on message.edit({ attachments: [] }), where those typings do already exist, please provide a reproducible code sample because I wasn't able to get any errors.

[Milo123459]

Yea, I think it was something to do with Yarn's PnP and my workspace typescript version, that one seems to of been fixed, this PR should now focus on fixing InteractionUpdateOptions

[Milo123459]

Anything else need to be changed?