Skip to content

Commit

Permalink
Add new attributes to Guild struct
Browse files Browse the repository at this point in the history
  • Loading branch information
@jb3
jb3 committed May 5, 2024
1 parent 5ff5ed5 commit 0336c00
Showing 1 changed file with 187 additions and 5 deletions.
192 changes: 187 additions & 5 deletions lib/nostrum/struct/guild.ex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ defmodule Nostrum.Struct.Guild do
:system_channel_id,
:rules_channel_id,
:public_updates_channel_id,
:safety_alerts_channel_id,
:joined_at,
:large,
:unavailable,
Expand All @@ -49,7 +50,21 @@ defmodule Nostrum.Struct.Guild do
:channels,
:guild_scheduled_events,
:vanity_url_code,
:threads
:threads,
:discovery_splash,
:system_channel_flags,
:max_presences,
:max_members,
:description,
:banner,
:premium_tier,
:premium_subscription_count,
:preferred_locale,
:max_video_channel_users,
:max_stage_video_channel_users,
:welcome_screen,
:nsfw_level,
:premium_progress_bar_enabled
]

@typedoc "The guild's id"
Expand Down Expand Up @@ -161,6 +176,55 @@ defmodule Nostrum.Struct.Guild do
@typedoc since: "0.5.1"
@type threads :: %{required(Channel.id()) => Channel.t()} | nil

@typedoc "Hash of the Discovery splash screen"
@type discovery_splash :: String.t() | nil

@typedoc """
Bitset representing the system channel flags
Use `Nostrum.Struct.Guild.SystemChannelFlags` to parse.
"""
@type system_channel_flags :: pos_integer()

@typedoc "Maximum number of presences for the guild"
@type max_presences :: pos_integer() | nil

@typedoc "Maximum members for the guild"
@type max_members :: pos_integer() | nil

@typedoc "User-set description of the guild"
@type description :: String.t() | nil

@typedoc "Banner hash for the guild, if prefixed with `a_` an animated GIF is available."
@type banner :: String.t() | nil

@typedoc "Premium tier of the guild (0-3)"
@type premium_tier :: 0..3

@typedoc "Number of boosts received by the guild"
@type premium_subscription_count :: pos_integer() | nil

@typedoc "Preferred locale for the guild, set by the user"
@type preferred_locale :: String.t() | nil

@typedoc "The maximum amount of users in a video channel"
@type max_video_channel_users :: pos_integer() | nil

@typedoc "The maximum amount of users in a stage video channel"
@type max_stage_video_channel_users :: pos_integer() | nil

@typedoc "The welcome screen of a Community guild, shown to new members, returned in an Invite's guild object"
@type welcome_screen :: map() | nil

@typedoc "NSFW level for the guild, unrated guilds have `:default`"
@type nsfw_level :: :default | :explicit | :safe | :age_restricted

@typedoc "Whether the guild has the boost progress bar enabled"
@type premium_progress_bar_enabled :: boolean

@typedoc "The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord"
@type safety_alerts_channel_id :: Channel.id() | nil

@typedoc """
A `Nostrum.Struct.Guild` that is sent on user-specific rest endpoints.
"""
Expand Down Expand Up @@ -193,7 +257,22 @@ defmodule Nostrum.Struct.Guild do
voice_states: nil,
channels: nil,
vanity_url_code: nil,
threads: nil
threads: nil,
discovery_splash: nil,
system_channel_flags: nil,
max_presences: nil,
max_members: nil,
description: nil,
banner: nil,
premium_tier: nil,
premium_subscription_count: nil,
preferred_locale: nil,
max_video_channel_users: nil,
max_stage_video_channel_users: nil,
welcome_screen: nil,
nsfw_level: nil,
premium_progress_bar_enabled: nil,
safety_alerts_channel_id: nil
}

@typedoc """
Expand Down Expand Up @@ -229,7 +308,22 @@ defmodule Nostrum.Struct.Guild do
voice_states: nil,
channels: nil,
guild_scheduled_events: nil,
threads: nil
threads: nil,
discovery_splash: nil,
system_channel_flags: nil,
max_presences: nil,
max_members: nil,
description: nil,
banner: nil,
premium_tier: nil,
premium_subscription_count: nil,
preferred_locale: nil,
max_video_channel_users: nil,
max_stage_video_channel_users: nil,
welcome_screen: nil,
nsfw_level: nil,
premium_progress_bar_enabled: nil,
safety_alerts_channel_id: nil
}

@typedoc """
Expand Down Expand Up @@ -265,7 +359,22 @@ defmodule Nostrum.Struct.Guild do
channels: nil,
guild_scheduled_events: nil,
vanity_url_code: nil,
threads: nil
threads: nil,
discovery_splash: nil,
system_channel_flags: nil,
max_presences: nil,
max_members: nil,
description: nil,
banner: nil,
premium_tier: nil,
premium_subscription_count: nil,
preferred_locale: nil,
max_video_channel_users: nil,
max_stage_video_channel_users: nil,
welcome_screen: nil,
nsfw_level: nil,
premium_progress_bar_enabled: nil,
safety_alerts_channel_id: nil
}

@typedoc """
Expand Down Expand Up @@ -301,7 +410,22 @@ defmodule Nostrum.Struct.Guild do
channels: channels,
guild_scheduled_events: guild_scheduled_events,
vanity_url_code: vanity_url_code,
threads: threads
threads: threads,
discovery_splash: discovery_splash,
system_channel_flags: system_channel_flags,
max_presences: max_presences,
max_members: max_members,
description: description,
banner: banner,
premium_tier: premium_tier,
premium_subscription_count: premium_subscription_count,
preferred_locale: preferred_locale,
max_video_channel_users: max_video_channel_users,
max_stage_video_channel_users: max_stage_video_channel_users,
welcome_screen: welcome_screen,
nsfw_level: nsfw_level,
premium_progress_bar_enabled: premium_progress_bar_enabled,
safety_alerts_channel_id: safety_alerts_channel_id
}

@type t ::
Expand Down Expand Up @@ -364,6 +488,52 @@ defmodule Nostrum.Struct.Guild do
def splash_url(%__MODULE__{splash: splash, id: id}, image_format),
do: URI.encode(Constants.cdn_url() <> Constants.cdn_splash(id, splash, image_format))

@doc ~S"""
Returns the URL of the guild's discovery splash, or `nil` if no splash.
Supported image formats are PNG, JPEG and WebP.
## Examples
```elixir
iex> guild = %Nostrum.Struct.Guild{discovery_splash: "656477617264736e6f7764656e",
...> id: 112233445566778899}
iex> Nostrum.Struct.Guild.discovery_splash_url(guild)
"https://cdn.discordapp.com/discovery-splashes/112233445566778899/656477617264736e6f7764656e.webp"
iex> Nostrum.Struct.Guild.discovery_splash_url(guild, "png")
"https://cdn.discordapp.com/discovery-splashes/112233445566778899/656477617264736e6f7764656e.png"
```
"""
@spec discovery_splash_url(t, String.t()) :: String.t() | nil
def discovery_splash_url(guild, image_format \\ "webp")
def discovery_splash_url(%__MODULE__{discovery_splash: nil}, _), do: nil

def discovery_splash_url(%__MODULE__{discovery_splash: dsp, id: id}, image_format),
do: Constants.cdn_url() <> Constants.cdn_discovery_splash(id, dsp, image_format)

@doc ~S"""
Returns the URL of the guild's banner, or `nil` if no splash.
Supported image formats are PNG, GIF, JPEG and WebP.
## Examples
```elixir
iex> guild = %Nostrum.Struct.Guild{banner: "656477617264736e6f7764656e",
...> id: 112233445566778899}
iex> Nostrum.Struct.Guild.banner_url(guild)
"https://cdn.discordapp.com/banners/112233445566778899/656477617264736e6f7764656e.webp"
iex> Nostrum.Struct.Guild.banner_url(guild, "png")
"https://cdn.discordapp.com/banners/112233445566778899/656477617264736e6f7764656e.png"
```
"""
@spec discovery_splash_url(t, String.t()) :: String.t() | nil
def banner_url(guild, image_format \\ "webp")
def banner_url(%__MODULE__{banner: nil}, _), do: nil

def banner_url(%__MODULE__{banner: banner, id: id}, image_format),
do: Constants.cdn_url() <> Constants.cdn_guild_banner(id, banner, image_format)

@doc false
def p_encode do
%__MODULE__{}
Expand Down Expand Up @@ -392,10 +562,22 @@ defmodule Nostrum.Struct.Guild do
&Util.cast(&1, {:list, {:struct, ScheduledEvent}})
)
|> Map.update(:threads, nil, &Util.cast(&1, {:index, [:id], {:struct, Channel}}))
|> Map.update(:safety_alerts_channel_id, nil, &Util.cast(&1, Snowflake))
|> Map.update(:nsfw_level, nil, &cast_nsfw_level/1)

struct(__MODULE__, new)
end

@doc false
defp cast_nsfw_level(level) do
case level do
0 -> :default
1 -> :explicit
2 -> :safe
3 -> :age_restricted
end
end

@doc false
@spec merge(t, t) :: t
def merge(old_guild, new_guild) do
Expand Down

0 comments on commit 0336c00

Please # to comment.