couple of last fixes to helpers (#137)

Author: swrge

dimscord/helpers/guild.nim

@@ -41,16 +41,17 @@ template edit*(g: Guild;
     ##
     ## Read more at:
     ## https://discord.com/developers/docs/resources/guild#modify-guild
-    getClient.api.editGuild(
-        g.id, name, description, region, afk_channel_id, icon,
+    getClient.api.editGuild(g.id, name, description, region, afk_channel_id, icon,
         discovery_splash, owner_id, splash, banner,
-        safety_alerts_channel_id,
         system_channel_id, rules_channel_id,
+        safety_alerts_channel_id,
         preferred_locale, public_updates_channel_id,
         verification_level, default_message_notifications,
         system_channel_flags,
         explicit_content_filter, afk_timeout,
-        features, premium_progress_bar_enabled, reason
+        features,
+        premium_progress_bar_enabled,
+        reason
     )
 
 template getAuditLogs*(g: Guild;
@@ -71,7 +72,7 @@ template createRole*(g: Guild,
     getClient.api.createGuildRole(g.id,
         name, unicode_emoji, icon,
         hoist, mentionable, permissions,
-        role_colors, color, reason) 
+        role_colors, color, reason)
 
 template deleteRole*(g: Guild; r: Role): Future[void] =
     ## Deletes a guild role.
@@ -126,10 +127,10 @@ template getBans*(g: Guild): Future[seq[GuildBan]] =
     ## Gets all the guild bans.
     getClient.api.getGuildBans(g.id)
 
-template ban*(g: Guild; m: Member; delete_message_seconds: range[0..604800] = 0;
+template ban*(g: Guild; m: Member; delete_message_secs = 0;
         reason = ""): Future[void] =
     ## Creates a guild ban.
-    getClient.api.createGuildBan(g.id, m.user.id, delete_message_seconds, reason)
+    getClient.api.createGuildBan(g.id, m.user.id, delete_message_secs, reason)
 
 template bulkBan*(g: Guild;
         user_ids: seq[string];
@@ -202,24 +203,25 @@ template getScheduledEvents*(g: Guild): Future[seq[GuildScheduledEvent]] =
     ## Get all scheduled events in a guild.
     getClient.api.getScheduledEvents(g.id)
 
-template editEvent*(g: Guild; gse: GuildScheduledEvent;
+template editEvent*(gse: GuildScheduledEvent;
         name, start_time, image = none string;
-        channel_id, end_time, desc = none string;
+        channel_id, end_time, description = none string;
         privacy_level = none GuildScheduledEventPrivacyLevel;
         entity_type = none EntityType;
         entity_metadata = none EntityMetadata;
         status = none GuildScheduledEventStatus;
+        recurrence_rule = none RecurrenceRule;
         reason = ""
 ): Future[GuildScheduledEvent] =
     ## Update a scheduled event in a guild.
     ## Read more: https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event-json-params
     getClient.api.editScheduledEvent(
-        g.id, gse.id, name,
-        start_time, image,
-        channel_id, end_time, desc,
-        privacy_level, entity_type,
-        entity_metadata, status,
-        reason
+        gse.guild_id, gse.id, name,
+        start_time, image, channel_id, end_time,
+        description, privacy_level,
+        entity_type, entity_metadata,
+        status, recurrence_rule,
+        reason,
     )
 
 template delete*(gse: GuildScheduledEvent; reason = ""): Future[void] =

dimscord/helpers/message.nim

@@ -30,39 +30,23 @@ template reply*(m: Message, content = "";
         files: seq[DiscordFile] = @[];
         flags: set[MessageFlags] = {};
         stickers: seq[string] = @[];
-        allowed_mentions = none AllowedMentions;
+        allowed_mentions: Option[AllowedMentions] = none(AllowedMentions);
         nonce: Option[string] or Option[int] = none(int);
-        mention, failifnotexists, tts = false): Future[Message] =
+        mention = false; failifnotexists = false; tts = false): Future[Message] =
     ## Replies to a Message.
     ## - set `mention` to `true` in order to mention the replied message in Discord.
-    var refr = block:
-        (if mention: some m.reference else: none MessageReference)
-    getMessage(getClient.shards[0].cache.gchannel(m), "123")
-    # TEMPORARY
-
-    # getClient.api.sendMessage(
-    #     m.channel_id,
-    #     content=content, tts=tts, nonce=nonce,
-    #     flags=flags, files=files, embeds=embeds,
-    #     allowed_mentions=allowed_mentions, 
-    #     message_reference = refr, components=components,
-    #     attachments=attachments, stickers=stickers
-    # )
-
-template editMessage*(c: SomeChannel, m: Message;
-        content = "";
-        embeds: seq[Embed] = @[];
-        attachments: seq[Attachment] = @[];
-        components: seq[MessageComponent] = @[];
-        files: seq[DiscordFile] = @[];
-        tts = false;
-        flags = none int): Future[Message]  =
-    ## Edits a Message.
-    getClient.api.editMessage(
-        c.id, m.id,
-        content, tts, flags,
-        files, embeds, attachments,
-        components
+    ## - `failifnotexists` can be used to set the corresponding field on the message reference
+    ##   if your `MessageReference` type exposes e.g. `fail_if_not_exists`. See the commented
+    ##   example below.
+
+    let refr = if mention: some(m.reference)
+      else:
+        none(MessageReference)
+    getClient.api.sendMessage(
+        m.channel_id, content, tts, nonce,
+        flags, files, embeds, attachments,
+        allowed_mentions, refr, components,
+        stickers
     )
 
 template edit*(m: Message;
@@ -72,22 +56,18 @@ template edit*(m: Message;
         components: seq[MessageComponent] = @[];
         files: seq[DiscordFile] = @[];
         tts = false;
-        flags = none set[MessageFlags]): Future[Message]  =
+        flags: set[MessageFlags] = {}): Future[Message]  =
     ## Edits a Message.
-
-    # getMessage(getClient.shards[0].cache.gchannel(m), "123")
-    # ^^^ this is temp, it will be removed soon
-    discard await getClient.api.editMessage(
+    getClient.api.editMessage(
         m.channel_id, m.id,
-        content=content, tts=tts,
-        flags=flags,
-        files=files, embeds=embeds, attachments=attachments,
-        components=components
+        content, tts, flags,
+        files, embeds, attachments,
+        components
     )
 
 template delete*(m: Message; reason = ""): Future[void] =
     ## Deletes a discord Message.
-    getClient.api.deleteMessage(m.channel_id, m.id, reason)  
+    getClient.api.deleteMessage(m.channel_id, m.id, reason)
 
 template delete*(msgs: seq[Message]; reason = ""): Future[void] =
     ## Bulk deletes messages.

dimscord/helpers/user.nim

@@ -54,16 +54,14 @@ template getCommand*(app: Application;
         app.id, guild_id, command_id
     )
 
-template registerCommand*(app: Application;
-        name: string; description: string;
-        name_localizations: Option[Table[string,string]] = none(Table[string,string]);
-        description_localizations: Option[Table[string,string]] = none(Table[string,string]);
-        kind: ApplicationCommandType = atSlash;
-        guild_id: string = "";
-        dm_permission: bool = true;
-        nsfw: bool = false;
-        default_member_permissions: Option[PermissionFlags] = none(PermissionFlags);
-        options: seq[ApplicationCommandOption] = @[]
+template registerCommand*(app: Application; name: string;
+        description, guild_id = "";
+        name_localizations,description_localizations=none Table[string,string];
+        kind = atSlash; nsfw = false;
+        default_member_permissions = none set[PermissionFlags];
+        options: seq[ApplicationCommandOption] = @[];
+        integration_types = none seq[ApplicationIntegrationType];
+        contexts = none seq[InteractionContextType];
 ): Future[ApplicationCommand] =
     ## Create a guild slash command.
     ##
@@ -75,10 +73,12 @@ template registerCommand*(app: Application;
     ## as an existing command for your application will
     ## overwrite the old command.
     getClient.api.registerApplicationCommand(
-        app.id, name, description, guild_id,
-        name_localizations, description_localizations,
-        kind, dm_permission, nsfw,
-        default_member_permissions, options
+        app.id, name,
+        description, guild_id,
+        name_localizations,description_localizations,
+        kind, nsfw, default_member_permissions,
+        options, integration_types,
+        contexts
     )
 
 
@@ -95,16 +95,16 @@ template bulkRegisterCommands*(app: Application;
 template editCommand*(apc: ApplicationCommand;
         name, desc = "";
         name_localizations,description_localizations = none Table[string,string];
-        default_member_permissions = none PermissionFlags; nsfw = false;
+        default_member_permissions = none set[PermissionFlags]; nsfw = false;
         options: seq[ApplicationCommandOption] = @[]
 ): Future[ApplicationCommand] =
     ## Modify slash command for a specific application.
     ## - `guild_id` - Optional
     ## - `name` - Optional Character length (3 - 32)
     ## - `description` - Optional Character length (1 - 100)
     getClient.api.editApplicationCommand(
-        apc.application_id, apc.id, apc.guild_id.get,
-        name, desc, name_localizations, description_localizations,
+        apc.application_id, apc.id, apc.guild_id.get(""),
+        name, desc,name_localizations, description_localizations,
         default_member_permissions, nsfw, options
     )
 
@@ -175,11 +175,12 @@ template followup*(i: Interaction;
         i.application_id, i.token, content,
         tts, files, attachments, embeds,
         allowed_mentions, components,
-        (if ephemeral: some mfEphemeral.ord else: none int),
+        (if ephemeral: {MessageFlags.mfEphemeral} else: {}),
         thread_id, thread_name, applied_tags,
         poll
     )
 
+
 template editResponse*(i: Interaction;
         content = none string;
         embeds = newSeq[Embed]();

tests/testHelpers.nim

@@ -223,7 +223,7 @@ suite "Guild Helpers Tests":
       compiles(mockGuild.edit(system_channel_flags = some 0))
       compiles(mockGuild.edit(explicit_content_filter = some 0))
       compiles(mockGuild.edit(afk_timeout = some 0))
-      compiles(mockGuild.edit(features = @["test"]))
+      compiles(mockGuild.edit(features = some @["test"]))
       compiles(mockGuild.edit(premium_progress_bar_enabled = some true))
       compiles(mockGuild.edit(reason = "test reason"))
 
@@ -264,7 +264,7 @@ suite "Guild Helpers Tests":
   test "ban template":
     check:
       compiles(mockGuild.ban(mockMember))
-      compiles(mockGuild.ban(mockMember, delete_msg_days = 0))
+      compiles(mockGuild.ban(mockMember, delete_message_secs = 10))
       compiles(mockGuild.ban(mockMember, reason = "test reason"))
 
   test "getIntegrations template":
@@ -362,7 +362,7 @@ suite "Guild Helpers Tests":
       compiles(mockGuild.editRole(mockRole, name = some "test"))
       compiles(mockGuild.editRole(mockRole, icon = some "test"))
       compiles(mockGuild.editRole(mockRole, unicode_emoji = some "test"))
-      compiles(mockGuild.editRole(mockRole, permissions = some default(PermObj)))
+      compiles(mockGuild.editRole(mockRole, permissions = some PermissionFlags.fullSet))
       compiles(mockGuild.editRole(mockRole, color = some 0))
       compiles(mockGuild.editRole(mockRole, hoist = some true))
       compiles(mockGuild.editRole(mockRole, mentionable = some true))
@@ -410,21 +410,21 @@ suite "Guild Helpers Tests":
 
   test "editEvent template":
     check:
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, name = some "test"))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, reason = "test reason"))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, start_time = some "2023-01-01T00:00:00.000Z"))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, end_time = some "2023-01-01T00:00:00.000Z"))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, image = some "test"))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, reason = "test reason"))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, channel_id = some "test"))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, end_time = some "2023-01-01T00:00:00.000Z"))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, desc = some "test"))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, privacy_level = some splGuildOnly))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, entity_type = some etStageInstance))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, entity_metadata = some default(EntityMetadata)))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, status = some esScheduled))
-      compiles(mockGuild.editEvent(mockGuildScheduledEvent, reason = "test reason"))
+      compiles(mockGuildScheduledEvent.editEvent())
+      compiles(mockGuildScheduledEvent.editEvent(name = some "test"))
+      compiles(mockGuildScheduledEvent.editEvent(reason = "test reason"))
+      compiles(mockGuildScheduledEvent.editEvent(start_time = some "2023-01-01T00:00:00.000Z"))
+      compiles(mockGuildScheduledEvent.editEvent(end_time = some "2023-01-01T00:00:00.000Z"))
+      compiles(mockGuildScheduledEvent.editEvent(image = some "test"))
+      compiles(mockGuildScheduledEvent.editEvent(reason = "test reason"))
+      compiles(mockGuildScheduledEvent.editEvent(channel_id = some "test"))
+      compiles(mockGuildScheduledEvent.editEvent(end_time = some "2023-01-01T00:00:00.000Z"))
+      compiles(mockGuildScheduledEvent.editEvent(description = some "test"))
+      compiles(mockGuildScheduledEvent.editEvent(privacy_level = some splGuildOnly))
+      compiles(mockGuildScheduledEvent.editEvent(entity_type = some etStageInstance))
+      compiles(mockGuildScheduledEvent.editEvent(entity_metadata = some default(EntityMetadata)))
+      compiles(mockGuildScheduledEvent.editEvent(status = some esScheduled))
+      compiles(mockGuildScheduledEvent.editEvent(reason = "test reason"))
 
   test "editRule template":
     check:
@@ -465,20 +465,6 @@ suite "Message Helpers Tests":
       compiles(mockMessage.reply(mention = false))
       compiles(mockMessage.reply(failifnotexists = false))
 
-  test "editMessage template":
-    check:
-      compiles(mockSomeChannel.editMessage(mockMessage))
-      compiles(mockSomeChannel.editMessage(mockMessage, content = "updated"))
-      compiles(mockSomeChannel.editMessage(mockMessage, embeds = @[mockEmbed]))
-      compiles(
-        mockSomeChannel.editMessage(mockMessage, attachments = @[mockAttachment])
-      )
-      compiles(mockSomeChannel.editMessage(mockMessage, components = @[
-          mockComponent]))
-      compiles(mockSomeChannel.editMessage(mockMessage, files = @[mockFile]))
-      compiles(mockSomeChannel.editMessage(mockMessage, tts = false))
-      compiles(mockSomeChannel.editMessage(mockMessage, flags = mockOptionInt))
-
   test "edit message template":
     check:
       compiles(mockMessage.edit())
@@ -488,7 +474,7 @@ suite "Message Helpers Tests":
       compiles(mockMessage.edit(components = @[mockComponent]))
       compiles(mockMessage.edit(files = @[mockFile]))
       compiles(mockMessage.edit(tts = false))
-      compiles(mockMessage.edit(flags = mockOptionInt))
+      compiles(mockMessage.edit(flags = MessageFlags.fullSet))
 
   test "delete message template":
     check:
@@ -639,9 +625,8 @@ suite "User Helpers Tests":
       compiles(mockApplication.registerCommand("command_name", "command_description", name_localizations = some default(Table[string, string]), description_localizations = some default(Table[string, string])))
       compiles(mockApplication.registerCommand("command_name", "command_description", kind = ApplicationCommandType.atSlash))
       compiles(mockApplication.registerCommand("command_name", "command_description", guild_id = "guild_id"))
-      compiles(mockApplication.registerCommand("command_name", "command_description", dm_permission = true))
       compiles(mockApplication.registerCommand("command_name", "command_description", nsfw = true))
-      compiles(mockApplication.registerCommand("command_name", "command_description", default_member_permissions = some default(PermissionFlags)))
+      compiles(mockApplication.registerCommand("command_name", "command_description", default_member_permissions = some PermissionFlags.fullSet))
       compiles(mockApplication.registerCommand("command_name", "command_description", options = @[mockApplicationCommandOption]))
 
   test "followup template":
@@ -666,7 +651,7 @@ suite "User Helpers Tests":
       compiles(mockApplicationCommand.editCommand(desc = "new_desc"))
       compiles(mockApplicationCommand.editCommand(name_localizations = some default(Table[string, string])))
       compiles(mockApplicationCommand.editCommand(description_localizations = some default(Table[string, string])))
-      compiles(mockApplicationCommand.editCommand(default_member_permissions = some default(PermissionFlags)))
+      compiles(mockApplicationCommand.editCommand(default_member_permissions = some PermissionFlags.fullSet))
       compiles(mockApplicationCommand.editCommand(options = @[mockApplicationCommandOption]))
 
   test "delete command template":