feat(message): add nonce support

Author: cryptoAlgorithm

Sources/DiscordKitCore/Extensions/Snowflake+decode.swift

@@ -1,17 +1,19 @@
 //
-//  File.swift
+//  Snowflake+decode.swift
 //  
 //
 //  Created by Vincent Kwok on 26/5/22.
 //
 
 import Foundation
 
-extension Snowflake {
+let DISCORD_EPOCH = 1420070400000
+
+public extension Snowflake {
     /// Decodes this Snowflake into a Date
-    public func decodeToDate() -> Date? {
+    func decodeToDate() -> Date? {
         guard let intSnowflake = Int(self) else { return nil }
-        let millisTimestamp = (intSnowflake >> 22) + 1420070400000
+        let millisTimestamp = (intSnowflake >> 22) + DISCORD_EPOCH
         return Date(timeIntervalSince1970: Double(millisTimestamp) / 1000.0)
     }
 }

Sources/DiscordKitCore/Objects/Data/Message.swift

@@ -82,7 +82,7 @@ public class Message: Codable, GatewayData, Identifiable {
         public static let ephemeral = Self(rawValue: 1 << 6)
     }
 
-    public init(id: Snowflake, channel_id: Snowflake, guild_id: Snowflake? = nil, author: User, member: Member? = nil, content: String, timestamp: Date, edited_timestamp: Date? = nil, tts: Bool, mention_everyone: Bool, mentions: [User], mention_roles: [Snowflake], mention_channels: [ChannelMention]? = nil, attachments: [Attachment], embeds: [Embed], reactions: [Reaction]? = nil, pinned: Bool, webhook_id: Snowflake? = nil, type: MessageType, activity: MessageActivity? = nil, application: Application? = nil, application_id: Snowflake? = nil, message_reference: MessageReference? = nil, flags: Int? = nil, referenced_message: Message? = nil, interaction: MessageInteraction? = nil, thread: Channel? = nil, components: [MessageComponent]? = nil, sticker_items: [StickerItem]? = nil) {
+    public init(id: Snowflake, channel_id: Snowflake, guild_id: Snowflake? = nil, author: User, member: Member? = nil, content: String, timestamp: Date, edited_timestamp: Date? = nil, nonce: Nonce? = nil, tts: Bool, mention_everyone: Bool, mentions: [User], mention_roles: [Snowflake], mention_channels: [ChannelMention]? = nil, attachments: [Attachment], embeds: [Embed], reactions: [Reaction]? = nil, pinned: Bool, webhook_id: Snowflake? = nil, type: MessageType, activity: MessageActivity? = nil, application: Application? = nil, application_id: Snowflake? = nil, message_reference: MessageReference? = nil, flags: Int? = nil, referenced_message: Message? = nil, interaction: MessageInteraction? = nil, thread: Channel? = nil, components: [MessageComponent]? = nil, sticker_items: [StickerItem]? = nil, call: CallMessageComponent? = nil) {
         self.id = id
         self.channel_id = channel_id
         self.guild_id = guild_id
@@ -99,6 +99,7 @@ public class Message: Codable, GatewayData, Identifiable {
         self.attachments = attachments
         self.embeds = embeds
         self.reactions = reactions
+        self.nonce = nonce
         self.pinned = pinned
         self.webhook_id = webhook_id
         self.type = type
@@ -112,6 +113,7 @@ public class Message: Codable, GatewayData, Identifiable {
         self.thread = thread
         self.components = components
         self.sticker_items = sticker_items
+        self.call = call
     }
 
     /// ID of the message
@@ -132,79 +134,80 @@ public class Message: Codable, GatewayData, Identifiable {
     /// > author object corresponds to the webhook's id, username, and avatar.
     /// > You can tell if a message is generated by a webhook by checking for
     /// > the webhook_id on the message object.
-    public var author: User
+    public let author: User
 
     /// Member properties for this message's author
-    public var member: Member?
+    public let member: Member?
 
     /// Contents of the message
     ///
     /// Up to 2000 characters for non-premium users.
-    public var content: String
+    public let content: String
 
     /// When this message was sent
     public let timestamp: Date
 
     /// When this message was edited (or null if never)
-    public var edited_timestamp: Date?
+    public let edited_timestamp: Date?
 
     /// If this was a TTS message
-    public var tts: Bool
+    public let tts: Bool
 
     /// Whether this message mentions everyone
-    public var mention_everyone: Bool
+    public let mention_everyone: Bool
 
     /// Users specifically mentioned in the message
-    public var mentions: [User]
+    public let mentions: [User]
 
     /// Roles specifically mentioned in this message
-    public var mention_roles: [Snowflake]
+    public let mention_roles: [Snowflake]
 
     /// Channels specifically mentioned in this message
-    public var mention_channels: [ChannelMention]?
+    public let mention_channels: [ChannelMention]?
 
     /// Any attached files
     ///
     /// See ``Attachment`` for more details.
-    public var attachments: [Attachment]
+    public let attachments: [Attachment]
 
     /// Any embedded content
     ///
     /// See ``Embed`` for more details
-    public var embeds: [Embed]
+    public let embeds: [Embed]
 
     /// Reactions to the message
-    public var reactions: [Reaction]?
-    // Nonce can either be string or int and isn't important so I'm not including it for now
+    public let reactions: [Reaction]?
+
+    public let nonce: Nonce?
 
     /// If this message is pinned
-    public var pinned: Bool
+    public let pinned: Bool
 
     /// If the message is generated by a webhook, this is the webhook's ID
     ///
     /// Use this to check if the message is sent by a webhook. ``Message/author``
     /// will not be valid if this is not nil (was sent by a webhook).
-    public var webhook_id: Snowflake?
+    public let webhook_id: Snowflake?
 
     /// Type of message
     ///
     /// Refer to ``MessageType`` for possible values.
     public let type: MessageType
 
     /// Sent with Rich Presence-related chat embeds
-    public var activity: MessageActivity?
+    public let activity: MessageActivity?
 
     /// Sent with Rich Presence-related chat embeds
-    public var application: Application?
+    public let application: Application?
 
     /// If the message is an Interaction or application-owned webhook, this is the ID of the application
-    public var application_id: Snowflake?
+    public let application_id: Snowflake?
 
     /// Data showing the source of a crosspost, channel follow add, pin, or reply message
-    public var message_reference: MessageReference?
+    public let message_reference: MessageReference?
 
     /// Message flags
-    public var flags: Int?
+    public let flags: Int?
 
     /// The message associated with the message\_reference
     ///
@@ -220,19 +223,19 @@ public class Message: Codable, GatewayData, Identifiable {
     public let referenced_message: Message?
 
     /// Present if the message is a response to an Interaction
-    public var interaction: MessageInteraction?
+    public let interaction: MessageInteraction?
 
     /// The thread that was started from this message, includes thread member object
-    public var thread: Channel?
+    public let thread: Channel?
 
     /// Present if the message contains components like buttons, action rows, or other interactive components
-    public var components: [MessageComponent]?
+    public let components: [MessageComponent]?
 
     /// Present  if the message contains stickers
-    public var sticker_items: [StickerItem]?
+    public let sticker_items: [StickerItem]?
 
     /// Present if the message is a call in DM
-    public var call: CallMessageComponent?
+    public let call: CallMessageComponent?
 }
 
 /// A complete copy of ``Message`` but with most properties marked as Optional
@@ -274,19 +277,6 @@ public struct PartialMessage: Codable, GatewayData {
     public let sticker_items: [StickerItem]?
 }
 
-// MARK: Mostly implemented message struct, missing file params
-public struct OutgoingMessage: Codable {
-    public let content: String // The message contents (up to 2000 characters)
-    public let tts: Bool?
-    public let embeds: [Embed]?
-    public let embed: Embed? // Embedded rich content, depreciated in favor of embeds
-    public let allowed_mentions: AllowedMentions?
-    public let message_reference: MessageReference?
-    public let components: [MessageComponent]?
-    public let sticker_ids: [Snowflake]?
-    public let flags: Int?
-}
-
 public enum MessageActivityType: Int, Codable {
     case join = 1
     case spectate = 2

Sources/DiscordKitCore/Objects/Data/Nonce.swift

@@ -0,0 +1,49 @@
+//
+//  Nonce.swift
+//
+//
+//  Created by Vincent Kwok on 19/3/24.
+//
+
+import Foundation
+
+public enum Nonce: Codable, Equatable {
+    case string(String)
+    case int(Int)
+
+    public static func == (lhs: Self, rhs: Self) -> Bool {
+        lhs.value == rhs.value
+    }
+
+    public var value: String {
+        switch self {
+        case .string(let val):
+            return val
+        case .int(let val):
+            return String(val)
+        }
+    }
+
+    public func encode(to encoder: any Encoder) throws {
+        var container = encoder.singleValueContainer()
+        switch self {
+        case .string(let val):
+            try container.encode(val)
+        case .int(let val):
+            try container.encode(val)
+        }
+    }
+
+    public init(from decoder: any Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        if let str = try? container.decode(String.self) {
+            self = .string(str)
+        } else {
+            self = .int(try container.decode(Int.self))
+        }
+    }
+
+    public init() {
+        self = .string(Snowflake(timestamp: Date()))
+    }
+}

Sources/DiscordKitCore/Objects/Data/Snowflake.swift

@@ -8,3 +8,10 @@
 import Foundation
 
 public typealias Snowflake = String
+
+extension Snowflake {
+    init(timestamp: Date = .init()) {
+        let epoch = Int(timestamp.timeIntervalSince1970*1000) - DISCORD_EPOCH
+        self.init(epoch << 22)
+    }
+}

Sources/DiscordKitCore/Objects/REST/NewMessage.swift

@@ -26,12 +26,13 @@ public struct NewMessage: Encodable {
     public let components: [Component]?
     public let sticker_ids: [Snowflake]?
     public let attachments: [NewAttachment]?
+    public let nonce: Nonce?
     // file[n] // Handle file uploading later
     // attachments
     // let payload_json: Codable? // Handle this later
     public let flags: Int?
 
-	public init(content: String?, tts: Bool? = false, embeds: [Embed]? = nil, allowed_mentions: AllowedMentions? = nil, message_reference: MessageReference? = nil, components: [Component]? = nil, sticker_ids: [Snowflake]? = nil, attachments: [NewAttachment]? = nil, flags: Int? = nil) {
+    public init(content: String?, nonce: Nonce = .init(), tts: Bool? = false, embeds: [Embed]? = nil, allowed_mentions: AllowedMentions? = nil, message_reference: MessageReference? = nil, components: [Component]? = nil, sticker_ids: [Snowflake]? = nil, attachments: [NewAttachment]? = nil, flags: Int? = nil) {
 		self.content = content
 		self.tts = tts
 		self.embeds = embeds
@@ -41,6 +42,7 @@ public struct NewMessage: Encodable {
 		self.sticker_ids = sticker_ids
 		self.attachments = attachments
 		self.flags = flags
+        self.nonce = nonce
     }
 
     enum CodingKeys: CodingKey {
@@ -53,6 +55,7 @@ public struct NewMessage: Encodable {
         case sticker_ids
         case attachments
         case flags
+        case nonce
     }
 
     public func encode(to encoder: Encoder) throws {
@@ -66,6 +69,7 @@ public struct NewMessage: Encodable {
         try container.encodeIfPresent(sticker_ids, forKey: .sticker_ids)
         try container.encodeIfPresent(attachments, forKey: .attachments)
         try container.encodeIfPresent(flags, forKey: .flags)
+        try container.encodeIfPresent(nonce, forKey: .nonce)
 
         // Same workaround to encode array of protocols
         if let components = components {