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

discord: Added SelectedValue fields for Channel, Mentionable, User and Role SelectComponents #455

Merged
merged 8 commits into from
Oct 31, 2024
Merged

discord: Added SelectedValue fields for Channel, Mentionable, User and Role SelectComponents #455

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
431d83d
discord: Added SelectedValue fields for Channel, User and Role Select…
CosmicPredator Oct 24, 2024
744c10f
discord: Modified MentionableSelectComponent to accept both RoleID an…
CosmicPredator Oct 24, 2024
2e657c3
discord: Minor comment change
CosmicPredator Oct 24, 2024
6c06bb7
discord: Applied [this](https://github.com/diamondburned/arikawa/pull…
CosmicPredator Oct 25, 2024
9c8f154
discord: Modified MentionableSelectComponent to take in DefaultMentio…
CosmicPredator Oct 25, 2024
59550ee
comments: Little typo fix
CosmicPredator Oct 25, 2024
cb28e47
discord: Minor wordings and comment fix
CosmicPredator Oct 25, 2024
6466037
comments: Fix format
CosmicPredator Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions discord/component.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,8 @@ type UserSelectComponent struct {
ValueLimits [2]int `json:"-"`
// Disabled disables the select if true.
Disabled bool `json:"disabled,omitempty"`
// DefaultUsers is the slice of UserIDs that are marked as selected by default
DefaultUsers []UserID `json:"-"`
}

// ID implements the Component interface.
Expand All @@ -737,18 +739,34 @@ func (s *UserSelectComponent) _icp() {}
func (s *UserSelectComponent) MarshalJSON() ([]byte, error) {
type sel UserSelectComponent

type DefaultValue struct {
Id UserID `json:"id"`
Type string `json:"type"`
}

type Msg struct {
Type ComponentType `json:"type"`
*sel
MinValues *int `json:"min_values,omitempty"`
MaxValues *int `json:"max_values,omitempty"`
DefaultValues []DefaultValue `json:"default_values,omitempty"`
}

msg := Msg{
Type: UserSelectComponentType,
sel: (*sel)(s),
}

var defaultValues []DefaultValue

if len(s.DefaultUsers) > 0 {
for _, userId := range s.DefaultUsers {
defaultValues = append(defaultValues, DefaultValue{Id: userId, Type: "user"})
}
}

msg.DefaultValues = defaultValues

if s.ValueLimits != [2]int{0, 0} {
msg.MinValues = new(int)
msg.MaxValues = new(int)
Expand All @@ -771,6 +789,8 @@ type RoleSelectComponent struct {
ValueLimits [2]int `json:"-"`
// Disabled disables the select if true.
Disabled bool `json:"disabled,omitempty"`
// DefaultRoles is the slice of RoleIDs that are marked as selected by default
DefaultRoles []RoleID `json:"-"`
}

// ID implements the Component interface.
Expand All @@ -788,18 +808,34 @@ func (s *RoleSelectComponent) _icp() {}
func (s *RoleSelectComponent) MarshalJSON() ([]byte, error) {
type sel RoleSelectComponent

type DefaultValue struct {
Id RoleID `json:"id"`
Type string `json:"type"`
}

type Msg struct {
Type ComponentType `json:"type"`
*sel
MinValues *int `json:"min_values,omitempty"`
MaxValues *int `json:"max_values,omitempty"`
DefaultValues []DefaultValue `json:"default_values,omitempty"`
}

msg := Msg{
Type: RoleSelectComponentType,
sel: (*sel)(s),
}

var defaultValues []DefaultValue

if len(s.DefaultRoles) > 0 {
for _, roleId := range s.DefaultRoles {
defaultValues = append(defaultValues, DefaultValue{Id: roleId, Type: "role"})
}
}

msg.DefaultValues = defaultValues

if s.ValueLimits != [2]int{0, 0} {
msg.MinValues = new(int)
msg.MaxValues = new(int)
Expand All @@ -811,6 +847,22 @@ func (s *RoleSelectComponent) MarshalJSON() ([]byte, error) {
return json.Marshal(msg)
}

// DefaultMention type is a Union type which packs both UserID and RoleID
type DefaultMention struct {
userId UserID `json:"-"`
roleId RoleID `json:"-"`
}

// DefaultUserMention creates a new DefaultMention type with only UserID
func DefaultUserMention (userId UserID) DefaultMention {
return DefaultMention{userId: userId}
}

// DefaultRoleMention creates a new DefaultMention type with only RoleID
func DefaultRoleMention(roleId RoleID) DefaultMention {
return DefaultMention{roleId: roleId}
}

type MentionableSelectComponent struct {
// CustomID is the custom unique ID.
CustomID ComponentID `json:"custom_id,omitempty"`
Expand All @@ -822,6 +874,14 @@ type MentionableSelectComponent struct {
ValueLimits [2]int `json:"-"`
// Disabled disables the select if true.
Disabled bool `json:"disabled,omitempty"`
// DefaultMentions is the slice of User / Role Mentions that are selected by default
// Example:
// DefaultMentions: []DefaultMention{
// discord.DefaultUserMention(0382080830233),
// discord.DefaultRoleMention(4820380382080),
// ...
// }
DefaultMentions []DefaultMention `json:"-"`
}

// ID implements the Component interface.
Expand All @@ -839,18 +899,41 @@ func (s *MentionableSelectComponent) _icp() {}
func (s *MentionableSelectComponent) MarshalJSON() ([]byte, error) {
type sel MentionableSelectComponent

type DefaultValue struct {
Id Snowflake `json:"id"`
Type string `json:"type"`
}

type Msg struct {
Type ComponentType `json:"type"`
*sel
MinValues *int `json:"min_values,omitempty"`
MaxValues *int `json:"max_values,omitempty"`
DefaultValues []DefaultValue `json:"default_values,omitempty"`
}

msg := Msg{
Type: MentionableSelectComponentType,
sel: (*sel)(s),
}

var defaultValues []DefaultValue

if len(s.DefaultMentions) > 0 {
for _, mention := range s.DefaultMentions {
if mention.userId.IsValid() {
defaultValues =
append(defaultValues, DefaultValue{Id: Snowflake(mention.userId), Type: "user"})
}
if mention.roleId.IsValid() {
defaultValues =
append(defaultValues, DefaultValue{Id: Snowflake(mention.roleId), Type: "role"})
}
}
}

msg.DefaultValues = defaultValues

if s.ValueLimits != [2]int{0, 0} {
msg.MinValues = new(int)
msg.MaxValues = new(int)
Expand All @@ -875,6 +958,8 @@ type ChannelSelectComponent struct {
Disabled bool `json:"disabled,omitempty"`
// ChannelTypes is the types of channels that can be chosen from.
ChannelTypes []ChannelType `json:"channel_types,omitempty"`
// DefaultChannels is the list of channels that are marked as selected by default.
DefaultChannels []ChannelID `json:"-"`
}

// ID implements the Component interface.
Expand All @@ -892,18 +977,34 @@ func (s *ChannelSelectComponent) _icp() {}
func (s *ChannelSelectComponent) MarshalJSON() ([]byte, error) {
type sel ChannelSelectComponent

type DefaultValue struct {
Id ChannelID `json:"id"`
Type string `json:"type"`
}

type Msg struct {
Type ComponentType `json:"type"`
*sel
MinValues *int `json:"min_values,omitempty"`
MaxValues *int `json:"max_values,omitempty"`
DefaultValues []DefaultValue `json:"default_values,omitempty"`
}

msg := Msg{
Type: ChannelSelectComponentType,
sel: (*sel)(s),
}

var defaultValues []DefaultValue

if len(s.DefaultChannels) > 0 {
for _, channelId := range s.DefaultChannels {
defaultValues = append(defaultValues, DefaultValue{Id: channelId, Type: "channel"})
}
}

msg.DefaultValues = defaultValues

if s.ValueLimits != [2]int{0, 0} {
msg.MinValues = new(int)
msg.MaxValues = new(int)
Expand Down
Loading