Merge pull request #23 from Humans-of-Julia/Options

Add helper functions to work with options

docs/src/helpers.md

@@ -19,4 +19,6 @@ set_game
 @fetchval
 @deferred_fetch
 @deferred_fetchval
+ops
+extops
 ```

src/Dizkord.jl

@@ -18,6 +18,7 @@ const Optional{T} = Union{T, Missing}
 const Nullable{T} = Union{T, Nothing}
 const OptionalNullable{T} = Union{T, Missing, Nothing}
 const StringOrChar = Union{AbstractString, AbstractChar}
+const MaybeAny = Union{T, Missing} where T<:Any
 
 # Constant functions.
 donothing(args...; kwargs...) = nothing

src/client/handlers.jl

@@ -48,7 +48,7 @@ function command!(f::Function, c::Client, name::AbstractString, description::Abs
     add_handler!(c, OnInteractionCreate(f; name=name))
     add_command!(c; name=name, description=description, kwargs...)
 end
-function command!(f::Function, c::Client, g::Int64, name::AbstractString, description::AbstractString; kwargs...)
+function command!(f::Function, c::Client, g::Number, name::AbstractString, description::AbstractString; kwargs...)
     add_handler!(c, OnInteractionCreate(f; name=name))
     add_command!(c, Snowflake(g); name=name, description=description, kwargs...)
 end

src/types/interaction.jl

@@ -58,18 +58,24 @@ struct ApplicationCommandChoice
 end
 @boilerplate ApplicationCommandChoice :constructors :docs :lower :merge
 
+# TODO: Custom type gen for `value` field of ApplicationCommandOption.
 """
 Application Command Option.
 More details [here](https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure).
 """
 struct ApplicationCommandOption 
+    value::MaybeAny
+    type::Optional{OptionType}
     name::Optional{String}
-    type::OptionType
-    value::Optional{Any}
+    description::Optional{String}
     required::Optional{Bool}
+    min_value::Optional{Number}
+    max_value::Optional{Number}
+    autocomplete::Optional{Bool}
     choices::Optional{Vector{ApplicationCommandChoice}}
     options::Optional{Vector{ApplicationCommandOption}}
     channel_types::Optional{Vector{ChannelTypes}}
+    focused::Optional{Bool}
 end
 @boilerplate ApplicationCommandOption :constructors :docs :lower :merge
 

src/types/types.jl

@@ -75,6 +75,7 @@ field(k::QuoteNode, ::Type{T}) where T = :($T(kwargs[$k]))
 field(k::QuoteNode, ::Type{Vector{Snowflake}}) = :(snowflake.(kwargs[$k]))
 field(k::QuoteNode, ::Type{Vector{DateTime}}) = :(datetime.(kwargs[$k]))
 field(k::QuoteNode, ::Type{Vector{T}}) where T = :($T.(kwargs[$k]))
+field(k::QuoteNode, ::Type{MaybeAny}) = :(haskey(kwargs, $k) ? kwargs[$k] : missing)
 function field(k::QuoteNode, ::Type{T}) where T <: Enum
     return :(kwargs[$k] isa Integer ? $T(Int(kwargs[$k])) :
              kwargs[$k] isa $T ? kwargs[$k] : $T(kwargs[$k]))

src/utils/helpers.jl

@@ -9,6 +9,8 @@ export PERM_NONE,
     heartbeat_ping,
     upload_file,
     set_game,
+    opt,
+    extops,
     @fetch,
     @fetchval,
     @deferred_fetch,
@@ -575,3 +577,23 @@ function deferfn!(ex, fns::Tuple, deferred::Symbol)
     append!(ex.args, repls)
     return ex
 end
+
+"""
+    opt(; kwargs...)
+
+Helper function that is equivalent to calling `ApplicationCommandOption(; type=3, kwargs...)`
+"""
+opt(; kwargs...) = ApplicationCommandOption(; type=3, kwargs...)
+"""
+    opt(ctx::Context)
+
+Helper function that is equivalent to calling `extops(ctx.interaction.data.options)`
+"""
+opt(ctx::Context) = extops(ctx.interaction.data.options)
+"""
+    extops(ops::Vector)
+
+Creates a Dict of `option name` -> `option value` for the given vector of [`ApplicationCommandOption`](@ref). 
+If the option is of `Subcommand` type, creates a dict for all its subcommands.
+"""
+extops(ops::Vector) = Dict([(op.name, Int(op.type) < 3 ? extops(op.options) : op.value) for op in ops])

test/fulltest.jl

@@ -7,30 +7,27 @@ client = Client(
     intents(GUILDS, GUILD_MESSAGES)
 )
 
+TESTGUILD = ENV["TESTGUILD"] isa Number ? ENV["TESTGUILD"] : parse(Int, ENV["TESTGUILD"])
+
 on_message!(client) do (ctx) 
     if ctx.message.author.id != me(client).id
         Dizkord.reply(client, ctx, content="<@$(ctx.message.author.id)>, $(ctx.message.content) TEST")
     end
 end
 
-command!(client, 776251117616234506, "boom", "Go boom!") do (ctx) 
+command!(client, TESTGUILD, "boom", "Go boom!") do (ctx) 
     Dizkord.reply(client, ctx, content="<@$(ctx.interaction.member.user.id)> blew up!")
 end
 
-command!(client, 776251117616234506, "bam", "Go bam!") do (ctx) 
+command!(client, TESTGUILD, "bam", "Go bam!") do (ctx) 
     Dizkord.reply(client, ctx, content="<@$(ctx.interaction.member.user.id)> slapped themselves!")
 end
 
-command!(client, 776251117616234506, "quit", "Ends the bot process!") do (ctx) 
-    Dizkord.reply(client, ctx, content="Shutting down the bot")
-    close(client)
-end
-
-command!(client, 776251117616234506, "crack", "Go crack!") do (ctx) 
-    Dizkord.reply(client, ctx, content="<@$(ctx.interaction.member.user.id)> hit a pole")
+command!(client, TESTGUILD, "water", "Water the plants!"; options=[opt(name="someop", description="Dosum")]) do (ctx) 
+    Dizkord.reply(client, ctx, content="<@$(ctx.interaction.member.user.id)> watered the plant so much they grew taller than them!\n$(opt(ctx))")
 end
 
-command!(client, 776251117616234506, "quit", "Ends the bot process!") do (ctx) 
+command!(client, TESTGUILD, "quit", "Ends the bot process!") do (ctx) 
     Dizkord.reply(client, ctx, content="Shutting down the bot")
     close(client)
 end