interactions #5106

devsnek · 2020-12-11T19:25:55Z

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

Status

This will need #4879 before it lands.

Code changes have been tested against the Discord API, or there are no code changes
I know how to update typings and have done so, or typings don't need updating

Semantic versioning classification:

This PR changes the library's interface (methods or parameters added)
- This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
This PR only includes non-code changes, like changes to documentation, README, etc.

src/structures/APIMessage.js

src/client/InteractionClient.js

src/structures/Interaction.js

src/client/Client.js

src/client/InteractionClient.js

src/structures/ApplicationCommand.js

src/structures/Interaction.js

src/client/InteractionClient.js

src/structures/ApplicationCommand.js

src/structures/Guild.js

src/structures/ApplicationCommand.js

src/client/InteractionClient.js

src/structures/Interaction.js

ThaTiemsz · 2020-12-13T17:36:51Z

I feel like this is missing a couple of stuff. Such as editing commands, editing the message(s), and sending follow up messages.

Side note: I was thinking, perhaps Interaction.options could be mapped to a Collection so you can easily do Interaction.options.get("key") instead of having to do Interaction.options.find(o => o.name === "key") every time.

devsnek · 2020-12-13T17:41:09Z

options may support repetition in the future, so a map would cause issues. note that this is only intended to accurately expose the capability of the api, for higher level interaction you should use something like commando.

src/structures/APIMessage.js

src/structures/Interaction.js

src/structures/ApplicationCommand.js

ckohen · 2020-12-15T02:31:36Z

This will likely need a InteractionMessageOptions as Interactions don't take all the same options as normal messages (including the additional ephemeral flag)

src/client/InteractionClient.js

NotSugden · 2020-12-15T14:24:37Z

src/client/InteractionClient.js

+
+        /**
+         * Emitted when an interaction is created.
+         * @event Client#interactionCreate


there should also be a docstring to indicate this event is emitted on InteractionClient

or perhaps just emit the event on the InteractionClient only

src/client/InteractionClient.js

src/client/voice/dispatcher/StreamDispatcher.js

almostSouji · 2020-12-15T23:23:52Z

✏ note: documentation has been finalized (at least for the beta period) at https://discord.com/developers/docs/interactions/slash-commands

src/client/InteractionClient.js

src/structures/APIMessage.js

src/client/InteractionClient.js

Romvnly-Gaming

this.client.api.applications('@me') should be this.client.api.applications(this.client.id) Discord expects a snowflake.

XynoxTheDev

Sry by mistake, pls delete this.

ckohen · 2020-12-17T23:32:20Z

This will need changes to APIRouter to account for all additional type of major id: webhooks

src/client/InteractionClient.js

ckohen · 2021-03-15T11:14:45Z

So we would make two calls to .reply() then? One as .reply({ deferred: true, ephemeral: true }) and the second would be the actual response? And I can't seem to find where this is implemented.

devsnek · 2021-03-15T11:50:01Z

you just call reply normally. the library automatically handles whether it should be deferred or not, and the message utils handle the ephemeral option.

src/structures/CommandInteraction.js

src/client/InteractionClient.js

NotSugden · 2021-03-15T16:11:23Z

typings/index.d.ts

+    public readonly applicationID: Snowflake;
+    public readonly channel: TextChannel | NewsChannel | DMChannel | null;
+    public readonly channelID: Snowflake | null;
+    public readonly guild: Guild | null;
+    public readonly guildID: Snowflake | null;
+    public readonly id: Snowflake;
+    public readonly member: GuildMember | null;
+    public readonly token: string;
+    public readonly type: InteractionType;
+    public readonly user: User | null;


Suggested change

public readonly applicationID: Snowflake;

public readonly channel: TextChannel | NewsChannel | DMChannel | null;

public readonly channelID: Snowflake | null;

public readonly guild: Guild | null;

public readonly guildID: Snowflake | null;

public readonly id: Snowflake;

public readonly member: GuildMember | null;

public readonly token: string;

public readonly type: InteractionType;

public readonly user: User | null;

public applicationID: Snowflake;

public channel: TextChannel | NewsChannel | DMChannel | null;

public channelID: Snowflake | null;

public guild: Guild | null;

public guildID: Snowflake | null;

public id: Snowflake;

public member: GuildMember | null;

public token: string;

public type: InteractionType;

public user: User | null;

NotSugden · 2021-03-15T16:13:10Z

typings/index.d.ts

+    public readonly commandID: Snowflake;
+    public readonly commandName: string;
+    public readonly createdAt: Date;
+    public readonly createdTimestamp: number;
+    public readonly options: object;


Suggested change

public readonly commandID: Snowflake;

public readonly commandName: string;

public readonly createdAt: Date;

public readonly createdTimestamp: number;

public readonly options: object;

public commandID: Snowflake;

public commandName: string;

public readonly createdAt: Date;

public readonly createdTimestamp: number;

public options: object;

ckohen · 2021-03-15T20:42:58Z

you just call reply normally. the library automatically handles whether it should be deferred or not, and the message utils handle the ephemeral option.

I see the automatic handling of deferred and how ephemeral is handled, I see no way to defer with ephemeral, as it must be set in the original callback.

Side note: the deferred message will show the user the interaction has timed out with the current handling, even after a reply, if the timeout for deferred has been reached.

ChristianTucker · 2021-03-16T08:28:50Z

Pulled the PR to mess about, may want to modify the readme to show the new parameter requirements for Client (CLIENT_MISSING_INTENTS). The documentation is also lacking, but I'm assuming that it will be automatically generated on merge.

JKLorenzo · 2021-03-16T08:39:47Z

Pulled the PR to mess about, may want to modify the readme to show the new parameter requirements for Client (CLIENT_MISSING_INTENTS). The documentation is also lacking, but I'm assuming that it will be automatically generated on merge.

I think its because of #4879.

vaporoxx · 2021-03-16T09:12:38Z

#5323 Takes care of the README change.

src/structures/CommandInteraction.js

NotSugden · 2021-03-16T19:58:22Z

src/structures/CommandInteraction.js

+   * @param {(StringResolvable | APIMessage)?} content The content for the message.
+   * @param {(MessageOptions | MessageAdditions)?} options The options to provide.


Suggested change

* @param {(StringResolvable | APIMessage)?} content The content for the message.

* @param {(MessageOptions | MessageAdditions)?} options The options to provide.

* @param {StringResolvable|APIMessage} content The content for the message.

* @param {MessageOptions|MessageAdditions} [options] The options to provide.

luckspt · 2021-03-16T20:23:16Z

src/structures/CommandInteraction.js

+     * @type {Object}
+     * @readonly
+     */
+    this.options = data.data.options.map(map);


Suggested change

this.options = data.data.options.map(map);

this.options = data.data.options?.map(map);

options can be undefined when a command doesn't have parameters (or none are given when executing the command)

Suggested change

this.options = data.data.options.map(map);

this.options = data.data.options?.map(map) ?? [];

Wouldn't it be better if options was an empty array, instead of just being undefined?

vaporoxx

client.interactionClient.createCommand() is broken atm, this should fix it

vaporoxx · 2021-03-16T21:44:54Z

src/client/websocket/handlers/READY.js

@@ -12,6 +12,8 @@ module.exports = (client, { d: data }, shard) => {
    client.users.cache.set(clientUser.id, clientUser);
  }

+  client.applicationID = data.application.id;


Suggested change

client.applicationID = data.application.id;

client.applicationID = data.application.id;

client.interactionClient.applicationID = data.application.id;

Suggested change

client.applicationID = data.application.id;

client.applicationID = client.interactionClient.applicationID = data.application.id;

vaporoxx · 2021-03-16T21:46:00Z

src/client/InteractionClient.js

+   * @returns {ApplicationCommand} The created command.
+   */
+  async createCommand(command, guildID) {
+    let path = this.client.api.applications(this.clientID);


Suggested change

let path = this.client.api.applications(this.clientID);

let path = this.client.api.applications(this.applicationID);

rushiiMachine · 2021-03-19T02:09:47Z

src/structures/ApplicationCommand.js

+
+  /**
+   * Edit this command.
+   * @param {ApplicationCommandOptions} data The data to update the command with


I feel like this should be a separate type since all of the endpoint parameters are optional yet the type requires them + others that are thrown away

alternatively use Partial<ApplicationCommandOptions> as was going to be documented by #5144 but document it here instead

devsnek#13 creates a new typedef for that

the typedef created there still does not respect edit data being optional, while options becomes optional, name and description still are not.

ckohen · 2021-03-25T01:44:02Z

Seems this commit reverted all the typings and jsdoc changes c3c00fc

Also this seems like it needs #5223 to land now so editing and deleting original is possible (for deferred responses especially)

ObscuritySRL · 2021-03-28T21:24:56Z

CommandInteraction.js:42:32 should be ?. as o.options can be null for SUB_COMMAND, causing an error at .map(map).

NotSugden · 2021-03-29T07:50:58Z

src/structures/Interaction.js

+     * @type {?GuildMember}
+     * @readonly
+     */
+    this.member = data.member ? this.guild?.members.add(data.member, false) : null;


Suggested change

this.member = data.member ? this.guild?.members.add(data.member, false) : null;

this.member = (data.member && this.guild) ? this.guild.members.add(data.member, false) : null;

NotSugden · 2021-03-29T07:52:12Z

src/client/InteractionClient.js

+ */
+class InteractionClient extends BaseClient {
+  /**
+   * @param {Options} options Options for the client.


this Options type doesn't exist, would probably be good to give it a better name too

almostSouji · 2021-04-04T09:49:05Z

superseded by #5448

thepwrtank18 · 2021-05-09T04:02:16Z

#5448 is done!

SpaceEEC linked an issue Dec 11, 2020 that may be closed by this pull request

Slash Commands Support #5103

Closed

SpaceEEC added the reason: API support label Dec 11, 2020

HarmoGlace reviewed Dec 11, 2020

View reviewed changes

src/structures/APIMessage.js Show resolved Hide resolved

src/client/InteractionClient.js Show resolved Hide resolved

devsnek changed the title ~~interactions wip~~ interactions Dec 11, 2020

devsnek force-pushed the interactions branch from c942f86 to 5be3216 Compare December 11, 2020 20:22

ckohen reviewed Dec 11, 2020

View reviewed changes

src/structures/Interaction.js Outdated Show resolved Hide resolved

NotSugden suggested changes Dec 11, 2020

View reviewed changes

Extroonie reviewed Dec 12, 2020

View reviewed changes

src/client/InteractionClient.js Outdated Show resolved Hide resolved

src/structures/ApplicationCommand.js Outdated Show resolved Hide resolved

src/structures/Guild.js Outdated Show resolved Hide resolved

Extroonie reviewed Dec 12, 2020

View reviewed changes

src/structures/ApplicationCommand.js Outdated Show resolved Hide resolved

src/client/InteractionClient.js Outdated Show resolved Hide resolved

src/structures/Interaction.js Outdated Show resolved Hide resolved

src/structures/Interaction.js Outdated Show resolved Hide resolved

ckohen reviewed Dec 14, 2020

View reviewed changes

src/structures/APIMessage.js Outdated Show resolved Hide resolved

jonahsnider mentioned this pull request Dec 14, 2020

Switch signature verification to tweetnacl discord/discord-interactions-js#8

Closed

night reviewed Dec 14, 2020

View reviewed changes

src/structures/Interaction.js Outdated Show resolved Hide resolved

ckohen reviewed Dec 14, 2020

View reviewed changes

src/structures/ApplicationCommand.js Outdated Show resolved Hide resolved

NotSugden reviewed Dec 15, 2020

View reviewed changes

tipakA mentioned this pull request Dec 16, 2020

Slash Commands (as per the new addition, if possible currently) discordjs/guide#550

Closed

DrunkenToast mentioned this pull request Dec 16, 2020

chore: convert commands to slash commands practice-enterprise/canvas-discord-bot#25

Closed

danbulant reviewed Dec 16, 2020

View reviewed changes

src/client/InteractionClient.js Outdated Show resolved Hide resolved

multimeric mentioned this pull request Dec 17, 2020

Support slash commands bra1n/judgebot#146

Closed

castdrian reviewed Dec 17, 2020

View reviewed changes

src/client/InteractionClient.js Outdated Show resolved Hide resolved

src/structures/APIMessage.js Outdated Show resolved Hide resolved

src/client/InteractionClient.js Show resolved Hide resolved

Romvnly-Gaming suggested changes Dec 17, 2020

View reviewed changes

XynoxTheDev approved these changes Dec 17, 2020

View reviewed changes

ckohen reviewed Dec 18, 2020

View reviewed changes

src/client/InteractionClient.js Outdated Show resolved Hide resolved

devsnek force-pushed the interactions branch 2 times, most recently from 637531b to 1de89f0 Compare December 18, 2020 02:45

ThatTSGuy approved these changes Dec 18, 2020

View reviewed changes

NotSugden suggested changes Mar 15, 2021

View reviewed changes

reeCaptcha mentioned this pull request Mar 15, 2021

Update discord.py snippets to v2 Darkempire78/Discord-Tools#9

Open

quick007 approved these changes Mar 15, 2021

View reviewed changes

gruselhaus approved these changes Mar 16, 2021

View reviewed changes

NotSugden reviewed Mar 16, 2021

View reviewed changes

luckspt reviewed Mar 16, 2021

View reviewed changes

vaporoxx suggested changes Mar 16, 2021

View reviewed changes

rushiiMachine reviewed Mar 19, 2021

View reviewed changes

devsnek force-pushed the interactions branch from 8dbd695 to c3c00fc Compare March 25, 2021 01:12

interactions

5a7b88a

devsnek force-pushed the interactions branch from c3c00fc to 5a7b88a Compare March 25, 2021 01:16

NotSugden suggested changes Mar 29, 2021

View reviewed changes

SPGoding mentioned this pull request Mar 29, 2021

Use Discord's built-in slash commands mojira/mojira-discord-bot#181

Closed

McJeffr mentioned this pull request Mar 30, 2021

Implement Slash Commands Shotbow/ChatBot#123

Open

vaporoxx mentioned this pull request Mar 30, 2021

feat: interactions #5448

Merged

Keanu73 mentioned this pull request Apr 3, 2021

Slash commands support Keanu73/MarchyGuard#15

Open

This comment has been minimized.

Sign in to view

almostSouji closed this Apr 4, 2021

devsnek deleted the interactions branch April 12, 2021 22:08

iCrawl added this to the Version 13 milestone Jun 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

interactions #5106

interactions #5106

devsnek commented Dec 11, 2020 •

edited by Lewdcario

ThaTiemsz commented Dec 13, 2020

devsnek commented Dec 13, 2020

ckohen commented Dec 15, 2020

NotSugden Dec 15, 2020

almostSouji commented Dec 15, 2020 •

edited

Romvnly-Gaming left a comment

XynoxTheDev left a comment •

edited

ckohen commented Dec 17, 2020 •

edited

ckohen commented Mar 15, 2021

devsnek commented Mar 15, 2021

NotSugden Mar 15, 2021

NotSugden Mar 15, 2021

ckohen commented Mar 15, 2021 •

edited

ChristianTucker commented Mar 16, 2021

JKLorenzo commented Mar 16, 2021

vaporoxx commented Mar 16, 2021

NotSugden Mar 16, 2021

luckspt Mar 16, 2021

n3oney Mar 25, 2021

vaporoxx left a comment

vaporoxx Mar 16, 2021

NotSugden Mar 16, 2021

vaporoxx Mar 16, 2021

rushiiMachine Mar 19, 2021 •

edited

ckohen Mar 19, 2021

vaporoxx Mar 19, 2021

ckohen Mar 19, 2021

ckohen commented Mar 25, 2021

ObscuritySRL commented Mar 28, 2021 •

edited

NotSugden Mar 29, 2021

NotSugden Mar 29, 2021

This comment has been minimized.

almostSouji commented Apr 4, 2021

thepwrtank18 commented May 9, 2021

		* @param {(StringResolvable \| APIMessage)?} content The content for the message.
		* @param {(MessageOptions \| MessageAdditions)?} options The options to provide.

	this.options = data.data.options.map(map);
	this.options = data.data.options?.map(map);

	client.applicationID = data.application.id;
	client.applicationID = data.application.id;
	client.interactionClient.applicationID = data.application.id;

	client.applicationID = data.application.id;
	client.applicationID = client.interactionClient.applicationID = data.application.id;

	let path = this.client.api.applications(this.clientID);
	let path = this.client.api.applications(this.applicationID);

	this.member = data.member ? this.guild?.members.add(data.member, false) : null;
	this.member = (data.member && this.guild) ? this.guild.members.add(data.member, false) : null;

interactions #5106

interactions #5106

Conversation

devsnek commented Dec 11, 2020 • edited by Lewdcario

ThaTiemsz commented Dec 13, 2020

devsnek commented Dec 13, 2020

ckohen commented Dec 15, 2020

Choose a reason for hiding this comment

almostSouji commented Dec 15, 2020 • edited

Romvnly-Gaming left a comment

Choose a reason for hiding this comment

XynoxTheDev left a comment • edited

Choose a reason for hiding this comment

ckohen commented Dec 17, 2020 • edited

ckohen commented Mar 15, 2021

devsnek commented Mar 15, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ckohen commented Mar 15, 2021 • edited

ChristianTucker commented Mar 16, 2021

JKLorenzo commented Mar 16, 2021

vaporoxx commented Mar 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vaporoxx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rushiiMachine Mar 19, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ckohen commented Mar 25, 2021

ObscuritySRL commented Mar 28, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

almostSouji commented Apr 4, 2021

thepwrtank18 commented May 9, 2021

devsnek commented Dec 11, 2020 •

edited by Lewdcario

almostSouji commented Dec 15, 2020 •

edited

XynoxTheDev left a comment •

edited

ckohen commented Dec 17, 2020 •

edited

ckohen commented Mar 15, 2021 •

edited

rushiiMachine Mar 19, 2021 •

edited

ObscuritySRL commented Mar 28, 2021 •

edited