feat: new select menus #8793

didinele · 2022-10-28T14:06:53Z

Please describe the changes this PR makes and why it should be merged:
As discussed internally (see: https://canary.discord.com/channels/222078108977594368/999796393810067607/1035493023162830848), supersedes #8775

Things this PR does better:

Makes 0 breaking changes; in case of sensical class/method renames, re-exports/aliases were added under the old names with deprecation notices on them
After some discussion with other contributors, has all of the caching behavior set in stone - i.e. consistent with how slash commands behave
Cleaner/finished typings for the main lib
Split SelectMenuComponent into multiple classes
... few other things that no longer come to mind after the 3 hours this took

Closes #8753

Note: There is one caveat with the typings I wrote, AnySelectMenuInteraction is a confusing type name and something we moved away from in the past. Ideally this would just be named SelectMenuInteraction and be a union of all the possible select menu interaction classes, but this is not possible, as SelectMenuInteraction is the name of the old StringSelectMenuInteraction and is re-exported as such to prevent this PR from being breaking.

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 · 2022-10-28T14:06:58Z

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

2 Ignored Deployments

Name	Status	Preview	Updated
discord-js	⬜️ Ignored (Inspect)		Nov 1, 2022 at 5:28PM (UTC)
discord-js-guide	⬜️ Ignored (Inspect)		Nov 1, 2022 at 5:28PM (UTC)

codecov · 2022-10-28T14:32:16Z

Codecov Report

Merging #8793 (62f5240) into main (8b400ca) will decrease coverage by 6.34%.
The diff coverage is 88.31%.

❗ Current head 62f5240 differs from pull request most recent head 5bdf316. Consider uploading reports for the commit 5bdf316 to get more accurate results

@@            Coverage Diff             @@
##             main    #8793      +/-   ##
==========================================
- Coverage   91.97%   85.62%   -6.35%     
==========================================
  Files          10       96      +86     
  Lines        2107     9457    +7350     
  Branches      244     1134     +890     
==========================================
+ Hits         1938     8098    +6160     
- Misses        166     1317    +1151     
- Partials        3       42      +39

Flag	Coverage Δ
brokers	`65.24% <ø> (?)`
builders	`98.71% <88.31%> (?)`
collection	`100.00% <ø> (?)`
proxy	`81.53% <ø> (?)`
rest	`91.97% <ø> (ø)`
util	`100.00% <ø> (?)`
utilities	`100.00% <ø> (?)`
voice	`63.70% <ø> (?)`
ws	`59.83% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/builders/src/components/Components.ts	`87.87% <60.00%> (ø)`
...ers/src/components/selectMenu/ChannelSelectMenu.ts	`65.57% <65.57%> (ø)`
...src/components/selectMenu/MentionableSelectMenu.ts	`90.32% <90.32%> (ø)`
...ilders/src/components/selectMenu/RoleSelectMenu.ts	`90.32% <90.32%> (ø)`
...ilders/src/components/selectMenu/UserSelectMenu.ts	`90.32% <90.32%> (ø)`
...ilders/src/components/selectMenu/BaseSelectMenu.ts	`92.18% <92.18%> (ø)`
packages/builders/src/components/ActionRow.ts	`100.00% <100.00%> (ø)`
packages/builders/src/components/Assertions.ts	`100.00% <100.00%> (ø)`
...ders/src/components/selectMenu/StringSelectMenu.ts	`100.00% <100.00%> (ø)`
...rc/components/selectMenu/StringSelectMenuOption.ts	`100.00% <100.00%> (ø)`
... and 80 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

jaw0r3k · 2022-10-28T17:16:25Z

Its just copied lol

Qjuh · 2022-10-28T17:38:27Z

Its just copied lol

Did you actually read the bullet point list of five things this PR does better?

jaw0r3k · 2022-10-28T17:41:07Z

Its just copied lol

Did you actually read the bullet point list of five things this PR does better?

The only better thing i see is

Cleaner/finished typings for the main lib

Syjalo

Add BaseInteraction#isAnySelectMenu() that will be changed to BaseInteraction#isSelectMenu() in v15

didinele · 2022-10-28T18:48:21Z

Add BaseInteraction#isAnySelectMenu() that will be changed to BaseInteraction#isSelectMenu() in v15

Not a bad idea, will do tomorrow.

packages/discord.js/src/structures/MentionableSelectMenuInteraction.js

packages/discord.js/src/structures/UserSelectMenuInteraction.js

kyranet

We should also add type tests for the type narrowing between different select menu types.

packages/discord.js/src/structures/StringSelectMenuBuilder.js

packages/discord.js/typings/index.d.ts

Co-authored-by: Julian Vennen <julian@aternos.org>

didinele · 2022-10-31T18:56:48Z

Now also tested.

packages/discord.js/src/structures/MentionableSelectMenuInteraction.js

packages/discord.js/src/structures/UserSelectMenuInteraction.js

almeidx · 2022-10-31T19:18:21Z

Maybe bump discord-api-types to the latest version (0.37.6)?

Co-authored-by: Almeida <almeidx@pm.me>

didinele · 2022-10-31T19:29:35Z

Maybe bump discord-api-types to the latest version (0.37.6)?

Feel like that's out of scope for me at this point unless we need something from that version/it has relevant bug fixes.

packages/builders/src/components/selectMenu/ChannelSelectMenu.ts

packages/discord.js/src/structures/BaseInteraction.js

packages/discord.js/src/structures/ChannelSelectMenuInteraction.js

packages/discord.js/src/structures/MentionableSelectMenuInteraction.js

packages/builders/src/components/selectMenu/ChannelSelectMenu.ts

packages/builders/src/components/Assertions.ts

packages/discord.js/src/structures/InteractionCollector.js

packages/discord.js/src/structures/MentionableSelectMenuInteraction.js

Co-authored-by: Aura Román <kyradiscord@gmail.com>

@deprecated

* feat(builders): new select menus * chore: better re-exporting of deprecated classes * feat: new select menus * chore: typings * chore: add missing todo comment * chore: finish updating tests * chore: add runtime deprecation warnings * chore: format deprecation warning * feat(BaseInteraction): isAnySelectMenu * chore: requested changes * fix: deprecation comments * chore: update @deprecated comments in typings * chore: add tests for select menu type narrowing * fix: bad auto imports Co-authored-by: Julian Vennen <julian@aternos.org> * fix: properly handle resolved members * fix: collectors * chore: suggested changes Co-authored-by: Almeida <almeidx@pm.me> * fix(typings): bad class extends * feat(ChannelSelectMenuBuilder): validation * chore: update todo comment * refactor(ChannelSelectMenu): better handling of channel_types state * chore: style nit * chore: suggested nits Co-authored-by: Aura Román <kyradiscord@gmail.com> Co-authored-by: Julian Vennen <julian@aternos.org> Co-authored-by: Almeida <almeidx@pm.me> Co-authored-by: Aura Román <kyradiscord@gmail.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

didinele added 4 commits October 28, 2022 13:50

feat(builders): new select menus

ed5a261

chore: better re-exporting of deprecated classes

71e2871

feat: new select menus

1d4055a

chore: typings

aecbc03

github-actions bot added packages:builders packages:discord.js packages:rest packages:voice packages:ws labels Oct 28, 2022

github-actions bot requested review from iCrawl, kyranet, SpaceEEC and vladfrangu October 28, 2022 14:07

didinele added 2 commits October 28, 2022 17:08

chore: add missing todo comment

85a6cc1

chore: finish updating tests

e6eeb88

didinele force-pushed the feat/new-select-menus branch from c18538f to e6eeb88 Compare October 28, 2022 14:22

didinele added 2 commits October 28, 2022 18:01

chore: add runtime deprecation warnings

05226bd

chore: format deprecation warning

40703b4

Syjalo suggested changes Oct 28, 2022

View reviewed changes

packages/discord.js/src/structures/MentionableSelectMenuInteraction.js Show resolved Hide resolved

packages/discord.js/src/structures/MentionableSelectMenuInteraction.js Show resolved Hide resolved

packages/discord.js/src/structures/UserSelectMenuInteraction.js Show resolved Hide resolved

feat(BaseInteraction): isAnySelectMenu

03be08f

kyranet requested changes Oct 28, 2022

View reviewed changes

didinele added 2 commits October 28, 2022 22:55

chore: requested changes

4ee4aa0

fix: deprecation comments

20580d1

fix: bad auto imports

e559511

Co-authored-by: Julian Vennen <julian@aternos.org>

didinele force-pushed the feat/new-select-menus branch from e0d24f7 to e559511 Compare October 31, 2022 17:52

iCrawl requested a review from kyranet October 31, 2022 18:02

didinele added 2 commits October 31, 2022 20:31

fix: properly handle resolved members

f7c9df8

fix: collectors

ad908c2

SpaceEEC approved these changes Oct 31, 2022

View reviewed changes

almeidx requested changes Oct 31, 2022

View reviewed changes

packages/discord.js/src/structures/MentionableSelectMenuInteraction.js Outdated Show resolved Hide resolved

packages/discord.js/src/structures/UserSelectMenuInteraction.js Outdated Show resolved Hide resolved

almeidx reviewed Oct 31, 2022

View reviewed changes

packages/discord.js/src/structures/UserSelectMenuInteraction.js Outdated Show resolved Hide resolved

chore: suggested changes

74a0ce6

Co-authored-by: Almeida <almeidx@pm.me>

vladfrangu requested changes Nov 1, 2022

View reviewed changes

didinele added 2 commits November 1, 2022 15:42

fix(typings): bad class extends

9149eac

feat(ChannelSelectMenuBuilder): validation

a316475

Syjalo suggested changes Nov 1, 2022

View reviewed changes

packages/discord.js/src/structures/MentionableSelectMenuInteraction.js Show resolved Hide resolved

didinele added 2 commits November 1, 2022 17:05

chore: update todo comment

92ec4ad

refactor(ChannelSelectMenu): better handling of channel_types state

62f5240

vladfrangu requested changes Nov 1, 2022

View reviewed changes

packages/builders/src/components/selectMenu/ChannelSelectMenu.ts Outdated Show resolved Hide resolved

packages/builders/src/components/selectMenu/ChannelSelectMenu.ts Outdated Show resolved Hide resolved

chore: style nit

f5d654c

vladfrangu approved these changes Nov 1, 2022

View reviewed changes

kyranet requested changes Nov 1, 2022

View reviewed changes

packages/builders/src/components/Assertions.ts Outdated Show resolved Hide resolved

packages/discord.js/src/structures/InteractionCollector.js Outdated Show resolved Hide resolved

packages/discord.js/src/structures/MentionableSelectMenuInteraction.js Outdated Show resolved Hide resolved

chore: suggested nits

08b4bf3

Co-authored-by: Aura Román <kyradiscord@gmail.com>

kyranet approved these changes Nov 1, 2022

View reviewed changes

Merge branch 'main' into feat/new-select-menus

5bdf316

kyranet mentioned this pull request Nov 1, 2022

New select menus #8775

Closed

kodiakhq bot merged commit 5152abf into discordjs:main Nov 1, 2022

didinele deleted the feat/new-select-menus branch November 1, 2022 17:36

jaw0r3k mentioned this pull request Nov 2, 2022

feat: Add new selects menus discordjs/guide#1335

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: new select menus #8793

feat: new select menus #8793

didinele commented Oct 28, 2022 •

edited

Loading

vercel bot commented Oct 28, 2022 •

edited

Loading

codecov bot commented Oct 28, 2022 •

edited

Loading

jaw0r3k commented Oct 28, 2022 •

edited

Loading

Qjuh commented Oct 28, 2022

jaw0r3k commented Oct 28, 2022 •

edited

Loading

Syjalo left a comment

didinele commented Oct 28, 2022

kyranet left a comment

didinele commented Oct 31, 2022

almeidx commented Oct 31, 2022

didinele commented Oct 31, 2022

feat: new select menus #8793

feat: new select menus #8793

Conversation

didinele commented Oct 28, 2022 • edited Loading

vercel bot commented Oct 28, 2022 • edited Loading

codecov bot commented Oct 28, 2022 • edited Loading

Codecov Report

jaw0r3k commented Oct 28, 2022 • edited Loading

Qjuh commented Oct 28, 2022

jaw0r3k commented Oct 28, 2022 • edited Loading

Syjalo left a comment

Choose a reason for hiding this comment

didinele commented Oct 28, 2022

kyranet left a comment

Choose a reason for hiding this comment

didinele commented Oct 31, 2022

almeidx commented Oct 31, 2022

didinele commented Oct 31, 2022

didinele commented Oct 28, 2022 •

edited

Loading

vercel bot commented Oct 28, 2022 •

edited

Loading

codecov bot commented Oct 28, 2022 •

edited

Loading

jaw0r3k commented Oct 28, 2022 •

edited

Loading

jaw0r3k commented Oct 28, 2022 •

edited

Loading