JSON serialisation fix for MessageComponent with interactions, Generate new docs and fix gateway url issues

Author: krisppurg

dimscord/constants.nim

@@ -186,7 +186,7 @@ type
         sfUserSubscription  = 8
 const
     libName* =  "Dimscord"
-    libVer* =   "1.6.0"
+    libVer* =   "1.8.0"
     libAgent* = "DiscordBot (https://github.com/krisppurg/dimscord, v"&libVer&")"
 
     cdnBase* =               "https://cdn.discordapp.com/"

dimscord/gateway.nim

@@ -442,7 +442,7 @@ proc reconnect(s: Shard) {.async.} =
     s.reconnecting = true
     s.retry_info.attempts += 1
 
-    var url = s.resumeGatewayUrl
+    var url = if s.resumeGatewayUrl == "": s.gatewayUrl else: s.resumeGatewayUrl
     var query = "?v=" & $s.client.gatewayVersion
     when defined(discordEtf): query &= "&encoding=etf"
     if not url.endsWith("/"): url &= "/"
@@ -577,17 +577,7 @@ proc handleSocketMessage(s: Shard) {.async.} =
         var data: JsonNode
 
         when defined(discordCompress):
-            if packet[0] == Binary:
-                packet[1] = uncompress(packet[1])
-                # buffer &= packet[1]
-                # if len(packet[1]) >= 4:
-                #     if packet[1][^4..^1] == zlib_suffix:
-                #         packet[1] = uncompress(buffer)
-                #         buffer = ""
-                #     else:
-                #         return
-                # else:
-                #     return
+            if packet[0] == Binary: packet[1] = uncompress(packet[1])
 
         try:
             when defined(discordEtf):
@@ -598,7 +588,7 @@ proc handleSocketMessage(s: Shard) {.async.} =
                 s.logShard("A zombied connection was detected.")
             else:
                 s.logShard(
-                    "An error occurred while parsing data: "&packet[1]
+                    fmt"Received non-JSON message from gateway: '{packet[1]}'"
                 )
             autoreconnect = s.handleDisconnect(packet[1])
 
@@ -657,12 +647,10 @@ proc handleSocketMessage(s: Shard) {.async.} =
                 await s.identify()
         else:
             discard
-    if not reconnectable:
-        raise newException(Exception, "Fatal error occurred.")
 
-    if packet[0] == Close:
-        if not autoreconnect:
-            autoreconnect = s.handleDisconnect(packet[1])
+    # if packet[0] == Close:
+    #     if not autoreconnect:
+    #         autoreconnect = s.handleDisconnect(packet[1])
 
     s.stop = true
     s.reset()
@@ -674,9 +662,11 @@ proc handleSocketMessage(s: Shard) {.async.} =
         if not s.networkError: await s.handleSocketMessage()
     else:
         let info = extractCloseData(packet[1])
+        var reason = info.reason
+        if info.code == 4014: reason &= " Check if your priviliged intents you listed are enabled on the OAuth2 Bot Applications section via https://discord.dev/"
         raise newException(
             Exception,
-            "Fatal discord gateway error: "&"["&($info.code)&"] "&info.reason
+            "Fatal discord gateway error: "&"["&($info.code)&"] "&reason
         )
 
 proc endSession*(discord: DiscordClient) {.async.} =
@@ -721,11 +711,9 @@ proc startSession(s: Shard, url, query: string) {.async.} =
 # It will try to forcefully put message content intent if not specified.
 proc startSession*(discord: DiscordClient,
             autoreconnect = true;
-            gateway_intents: set[GatewayIntent] = {
-                    giGuilds, giGuildMessages,
-                    giDirectMessages, giGuildVoiceStates,
-                    giMessageContent
-            }; large_message_threshold, large_threshold = 50;
+            gateway_intents: set[GatewayIntent];
+            content_intent = true;
+            large_message_threshold, large_threshold = 50;
             max_message_size = 5_000_000;
             gateway_version = 10;
             max_shards = none int; shard_id = 0;
@@ -734,8 +722,7 @@ proc startSession*(discord: DiscordClient,
     ## Connects the client to Discord via gateway.
     ##
     ## - `gateway_intents` Allows you to subscribe to pre-defined events.
-    ##    **NOTE:** When not specified this will default to:
-    ##    `giGuilds, giGuildMessages, giDirectMessages, giGuildVoiceStates, giMessageContent`
+    ## - `content_intent` Whether to use discord's priviliged message content on by default. (defaults to `true`)
     ##
     ## - `large_threshold` The number that would be considered a large guild (50-250).
     ## - `guild_subscriptions` **DEPRECATED** Whether or not to receive presence_update, typing_start events.
@@ -750,13 +737,13 @@ proc startSession*(discord: DiscordClient,
 
     discord.autoreconnect = autoreconnect
 
-    # assert gateway_intents.len == 0, "Gateway intents cannot be empty."
     discord.intents = gateway_intents
 
     if giMessageContent notin discord.intents:
-        log("Warning: giMessageContent not specified this might cause issues.")
+        if content_intent: raise newException(Exception, "giMessageContent not in intents, if you wish to turn it off set content_intent = false in startSession")
 
     discord.largeThreshold = large_threshold
+    
     if guild_subscriptions:
         log("Warning: guild_subscriptions is deprecated.")
         discord.intents = discord.intents + {
@@ -768,8 +755,6 @@ proc startSession*(discord: DiscordClient,
 
     discord.max_shards = max_shards.get(-1)
     discord.gatewayVersion = gateway_version
-    # when defined(discordv8):
-    #     discord.gatewayVersion = 8
     when defined(discordv9):
         discord.gatewayVersion = 9
 
@@ -782,9 +767,6 @@ proc startSession*(discord: DiscordClient,
     when defined(discordEtf):
         query &= "&encoding=etf"
 
-    # when defined(discordCompress):
-    #     query &= "&compress=zlib-stream"
-
     if discord.shards.len == 0:
         log("Starting gateway session.")
 

dimscord/helpers.nim

@@ -613,6 +613,14 @@ template waitFor*(discord: DiscordClient; event: static[DispatchEvent],
     ## 
     ## See also:
     ## - [Events](./objects.html#Events)
+    ## 
+    ## Similar procs:
+    ## - [waitForComponentUse]
+    ## - [waitForDeletion]
+    ## - [waitForInternal]
+    ## - [waitForReaction]
+    ## - [waitForReply]
+    ## - [waitToJoinVoice]
     block:
         # Issue is that we can't refine the handler type to be
         # different depending on what event is. To get around this

dimscord/objects.nim

@@ -92,7 +92,7 @@ proc newDiscordClient*(token: string;
                     o: Option[Message], exists: bool) {.async.} = discard,
             message_reaction_add: proc (s: Shard,
                     m: Message, u: User,
-                    e: Emoji, exists: bool) {.async.} = discard,
+                    emj: Emoji, exists: bool) {.async.} = discard,
             message_reaction_remove: proc (s: Shard, m: Message,
                     u: User, r: Reaction, exists: bool) {.async.} = discard,
             message_reaction_remove_all: proc (s: Shard, m: Message,
@@ -897,6 +897,9 @@ proc `%%*`*(a: ApplicationCommand): JsonNode =
     softassert a.name.len in 1..32
     # This ternary is needed so that the enums can stay similar to
     # the discord api
+
+    # <TODO> PLEASE CLEAN UP THE CODE
+
     let commandKind = if a.kind == atNothing: atSlash else: a.kind
     result = %*{
         "name": a.name,
@@ -1017,6 +1020,8 @@ proc `&=`(a: var JsonNode, b: JsonNode) =
     a = a+b
 
 proc `%%*`*(comp: MessageComponent): JsonNode =
+    # Fyi, it's named that because originally it was meant to avoid conflicts with json but now since there is no conflicts,
+    # I thought I'd just keep it as it is and make a `%` that would redirect the proc.
     result = %*{"type": comp.kind.ord}
 
     result.loadOpts(comp, spoiler, placeholder, disabled, id, label, description)
@@ -1058,4 +1063,17 @@ proc `%%*`*(comp: MessageComponent): JsonNode =
     of mctSeparator: result.loadOpts(comp, divider, spacing)
     of mctTextDisplay: result["content"] = %comp.content
     of mctLabel:
-        result &= %*{"component": %%*comp.component}
+        result &= %*{"component": %%*comp.component}
+
+proc `%`*(m: MessageComponent): JsonNode = %%*m
+
+proc `%`*(m: InteractionCallbackDataMessage): JsonNode =
+    result = %*{
+        "content": m.content,
+        "embeds": %m.embeds.mapIt(%it),
+        "allowed_mentions": %m.allowed_mentions,
+        "flags": %m.flags,
+        "attachments": %m.attachments,
+        "components": %m.components.mapIt(%%*it)
+    }
+    result.loadOpts(m, tts)

dimscord/objects/typedefs.nim

@@ -401,7 +401,7 @@ type
         party*: Option[tuple[id: string, size: seq[int]]] ## todo
         assets*: Option[ActivityAssets]
         secrets*: Option[tuple[join, spectate, match: string]]
-        buttons*: seq[tuple[label, url: string]] # !!!! parsehooks
+        buttons*: seq[tuple[label, url: string]]
         instance*: bool
     Presence* = ref object
         user*: User
@@ -711,7 +711,7 @@ type
         ## ```
         name*: string
         name_localizations*: Option[Table[string, string]]
-        value*: (Option[string], Option[int]) # !!!!!!!!
+        value*: (Option[string], Option[int])
     MessageInteractionMetadata* = object
         id*, name*: string
         kind*: InteractionType
@@ -826,7 +826,6 @@ type
         flags*: set[MessageFlags]
         attachments*: seq[Attachment]
         components*: seq[MessageComponent]
-    # InteractionCallbackDataMessage* = InteractionApplicationCommandCallbackData
     InteractionCallbackDataAutocomplete* = object
         choices*: seq[ApplicationCommandOptionChoice]
     InteractionCallbackDataModal* = object
@@ -1034,12 +1033,36 @@ type
         shards*: int
         session_start_limit*: GatewaySession
     Events* = ref object
-        ## An object containing events that can be changed.
+        ## An object consisting of events that can be registered
+        ## 
+        ## Each property can be written in the following form:
+        ## ```nim
+        ## # for interaction_create for instance
+        ## proc interaction_create(s: Shard, i: Interaction) {.event(discord).} =
+        ##   ...
+        ## 
+        ## # The {.event(discord).} pragma is a macro which rewrites the expression as this:
+        ## discord.events.interaction_create = proc interaction_create(s: Shard, i: Interaction) {.async.} =
+        ##   ...
+        ## 
+        ## # the event name is also case insensitive (except for first letter),
+        ## # thanks to Nim's flexibility so writing the following would be valid equivalent.
+        ## 
+        ## proc interactionCreate(s: Shard, i: Interaction) {.event(discord).} =
+        ##   ...
+        ## 
+        ## # just don't forget the pragma, it also automatically adds in the {.async.} pragma
+        ## # hence why use of async/await inside proc is valid.
+        ## ```
+        ## 
+        ## Additional information:
+        ## - `exists` (parameter) Checks object is cached or not. Other cachable objects dont have them.
+        ## - `on_dispatch` (event) gives you the raw event data for you to handle things, useful for debugging. (see last bullet point for information)
+        ## - `message_reaction_add` (event) to get [Reaction] data you can do `msg.reactions[$emoji]`.
+        ## - [Discord API docs on gateway events](https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events)
         ##
-        ## - `exists` Checks message is cached or not. Other cachable objects dont have them.
         ##
-        ## - `on_dispatch` event gives you the raw event data for you to handle things.
-        ## [For reference](https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events)
+        ## - See also [waitFor] in helpers section 
         on_dispatch*: proc (s: Shard, evt: string, data: JsonNode) {.async.}
         on_ready*: proc (s: Shard, r: Ready) {.async.}
         on_disconnect*: proc (s: Shard) {.async.}

dimscord/restapi/requester.nim

@@ -137,9 +137,15 @@ proc request*(api: RestApi, meth, endpoint: string;
             reason: if audit_reason != "": audit_reason else: ""
         ))
 
-        try:
-            resp = await client.request(url, parseEnum[HttpMethod](meth),
+        let req = client.request(url, parseEnum[HttpMethod](meth),
                     pl, multipart=mp)
+
+        if not (await req.withTimeout(20_000)):
+            log("Request is taking longer than 20s. Retrying request...")
+            await doreq()
+
+        try:
+            resp = await req
         except:
             r.processing = false
             raise
@@ -218,6 +224,7 @@ proc request*(api: RestApi, meth, endpoint: string;
                 elif status == Http504:
                     error = fin & "Gateway timed out."
 
+            echo pl.parseJson.pretty()
             if fatalErr:
                 raise DiscordHttpError(
                     msg: error,

dimscord/restapi/user.nim

@@ -206,7 +206,7 @@ proc registerApplicationCommand*(api: RestApi; application_id: string;
     ## overwrite the old command.
     softAssert name.len in 1..32
     var payload = %*{"name": name,
-                     "type": ord kind}
+                     "type": %(ord kind)}
 
     if default_member_permissions.isSome:
         payload["default_member_permissions"] = %(
@@ -350,7 +350,22 @@ proc interactionResponseMessage*(api: RestApi,
         kind: InteractionResponseType,
         response: InteractionCallbackDataMessage) {.async.} =
     ## Create an interaction response.
-    ## `response.kind` is required.
+    ## - `response.kind` is required.
+    ## 
+    ## Example:
+    ## ```nim
+    ## await discord.api.interactionResponseMessage(
+    ##      interaction_id, interaction_token,
+    ##         kind = ..., # you can choose whichever
+    ##         response = InteractionCallbackDataMessage(
+    ##             flags: {mfIsEphemeral, mfIsComponentsV2},
+    ##             content: "What's up bro".
+    ##             components: @[...],
+    ##             ...
+    ##        )
+    ## )
+    ## )
+    ## ```
     var payload = %*{"type":int kind, "data": newJObject()}
     var mpd: MultipartData = nil
     if response != nil: