feat(ClientPresence): allow setting activity state

[advaith1]

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

custom status for bots!

• Bots can now set activity state discord/discord-api-docs#6345

Status and versioning classification:

• 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
• This PR changes the library's interface (methods or parameters added)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
discord-js	⬜️ Ignored (Inspect)	Visit Preview		Aug 12, 2023 11:28am
discord-js-guide	⬜️ Ignored (Inspect)	Visit Preview		Aug 12, 2023 11:28am

[jaw0r3k]

What about this one?

discord.js/packages/discord.js/src/structures/ClientPresence.js

Lines 64 to 69 in 7295a3a

	...this.activities.map(a => ({
	name: a.name,
	type: a.type,
	url: a.url ?? undefined,
	})),
	);

[advaith1]

oops, thanks!

[github-actions]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	73
🟢 Accessibility	97
🟢 Best practices	100
🟠 SEO	75
🔴 PWA	30

Lighthouse ran on https://discord-js-guide-git-fork-advaith1-custom-stat-200c77-discordjs.vercel.app/

[advaith1]

since name is required but not displayed for custom status, currently you would need to something like this which is not the best dx

client.user.setActivity('Custom Status', { state: 'hello world', type: ActivityType.Custom })

client.user.setActivity({ name: 'Custom Status', state: 'hello world', type: ActivityType.Custom })

(the client uses "Custom Status" for the name, though anything works)

so some things we can do are:

1. make the name field optional and default it to "Custom Status" for custom status activities
   but the code might be messy, since name is currently required

client.user.setActivity({ state: 'hello world', type: ActivityType.Custom })

2. default state to name for custom status activities
   in this case we could set name to "Custom Status" or just leave it as-is

client.user.setActivity('hello world', { type: ActivityType.Custom })

client.user.setActivity({ name: 'hello world', type: ActivityType.Custom })

3. add a setCustomStatus method that calls setActivity internally

client.user.setCustomStatus('hello world')

which one should we go with? or should we just leave it as it currently is, requiring name and state for custom status

[advaith1]

ready for review! looking for maintainer feedback about abstracting custom status ^

[vladfrangu]

I'm semi leaning towards 2 and 3, but lets wait for other maintainers to give their thoughts too

[Jiralite]

name as a required field for custom status sounds like something that should be raised to the Discord developers to see if they can change that. Has that been done already?

[Jiralite]

I would opt for 2, also just in case state becomes something usable in the future for custom statuses.

@vladfrangu I probably wouldn't go for 3 because it might be an incentive to create methods for other activity types.

---

Just looking at the method now... feels like both parameters should be consolidated into one ActivityOptions, but that can be done later.

[theredcmdcraft]

Maybe a stupid question but what about emojis with custom status?

[Jiralite]

Emojis cannot be used.

[jaw0r3k]

Maybe a stupid question but what about emojis with custom status?

They probably wont be added discord/discord-api-docs#6345 (comment)

[theredcmdcraft]

Emojis cannot be used.

Because of Discord Limitations? I`ve tried a little bit with emojis. I`ve used the following gateway json:

{
  "op": 3,
  "d": {
    "since": 91879201,
    "activities": [
      {
        "name": "galaxybot.app",
        "type": 4,
        "state": "galaxybot.app",
        "emoji": {
          "name": "smiley"
        }
      }
    ],
    "status": "online",
    "afk": false
  }
}

This Json I had sended to the discord gateway over the websocket. What I know you got instantly disconnected if your json is wrong, but i got not disconnected and the bot does not had an emoji. So my assumption is therefore, that the Discord Client, cannot display it, because it is a Bot User.

[iCrawl]

Option 2 sounds fine to me too.

[vladfrangu]

discord/discord-api-docs#6345 (comment)

FWIW name needs to be unicode and not the name of the emoji. That said, I doubt Discord allows it for bots (due to the nature of permission checking alone)

[advaith1]

implemented option 2 and tested

discord.js/packages/discord.js/src/structures/ClientPresence.js

Lines 57 to 60 in a9a3ed0

	if (activity.type === ActivityType.Custom && !activity.state) {
	activity.state = activity.name;
	activity.name = 'Custom Status';
	}

[GeekCornerGH]

Is there any chance this lands in v14 before v15 releases?

[kyranet]

v15's release isn't happening anytime soon, we're still working on v14, and this is a v14 PR.

[GeekCornerGH]

v15's release isn't happening anytime soon, we're still working on v14, and this is a v14 PR.

Fair enough, thanks!