Add require functions for Interaction.Data

Sources/DiscordModels/Types/Interaction.swift

@@ -14,6 +14,8 @@
 
         case componentWasNotOfKind(kind: String, component: ActionRow.Component)
 
+        case dataWasNotOfKind(kind: String, data: Interaction.Data)
+
         public var description: String {
             switch self {
             case let .optionNotFoundInCommand(name, command):
@@ -30,6 +32,8 @@
                 return "Interaction.Error.componentNotFoundInActionRows(customId: \(customId), actionRows: \(actionRows))"
             case let .componentWasNotOfKind(kind, component):
                 return "Interaction.Error.componentWasNotOfKind(kind: \(kind), component: \(component))"
+            case let .dataWasNotOfKind(kind, data):
+                return "Interaction.Error.dataWasNotOfKind(kind: \(kind), data: \(data))"
             }
         }
     }
@@ -262,6 +266,33 @@
         case applicationCommand(ApplicationCommand)
         case messageComponent(MessageComponent)
         case modalSubmit(ModalSubmit)
+
+        public func requireApplicationCommand() throws -> ApplicationCommand {
+            switch self {
+            case let .applicationCommand(applicationCommand):
+                return applicationCommand
+            default:
+                throw Error.dataWasNotOfKind(kind: "applicationCommand", data: self)
+            }
+        }
+
+        public func requireMessageComponent() throws -> MessageComponent {
+            switch self {
+            case let .messageComponent(messageComponent):
+                return messageComponent
+            default:
+                throw Error.dataWasNotOfKind(kind: "messageComponent", data: self)
+            }
+        }
+
+        public func requireModalSubmit() throws -> ModalSubmit {
+            switch self {
+            case let .modalSubmit(modalSubmit):
+                return modalSubmit
+            default:
+                throw Error.dataWasNotOfKind(kind: "modalSubmit", data: self)
+            }
+        }
     }
 
     public var id: InteractionSnowflake

Tests/DiscordBMTests/DiscordModels.swift

@@ -354,6 +354,29 @@ class DiscordModelsTests: XCTestCase {
         _ = try decoder.decode(Interaction.ApplicationCommand.ResolvedData.self, from: encoded)
     }
 
+    func testInteractionDataUtilities() throws {
+        let applicationCommand: Interaction.Data = .applicationCommand(
+            .init(id: "", name: "", type: .applicationCommand)
+        )
+
+        let messageComponent: Interaction.Data = .messageComponent(
+            .init(custom_id: "", component_type: .actionRow)
+        )
+
+        let modalSubmit: Interaction.Data = .modalSubmit(
+            .init(custom_id: "", components: [[.button(.init(label: "", url: ""))]])
+        )
+
+        XCTAssertNoThrow(try applicationCommand.requireApplicationCommand())
+        XCTAssertThrowsError(try messageComponent.requireApplicationCommand())
+
+        XCTAssertNoThrow(try messageComponent.requireMessageComponent())
+        XCTAssertThrowsError(try modalSubmit.requireMessageComponent())
+
+        XCTAssertNoThrow(try modalSubmit.requireModalSubmit())
+        XCTAssertThrowsError(try applicationCommand.requireModalSubmit())
+    }
+
     func testApplicationCommandUtilities() throws {
         let command = Interaction.ApplicationCommand(
             id: try! .makeFake(),
@@ -526,7 +549,7 @@ class DiscordModelsTests: XCTestCase {
         }
     }
 
-    func testCollectionisNotEmpty() throws {
+    func testCollectionIsNotEmpty() throws {
         let array1: [String]? = nil
         XCTAssertEqual(array1.isNotEmpty, false)
 

Tests/IntegrationTests/GatwayConnection.swift

@@ -26,6 +26,7 @@ class GatewayConnectionTests: XCTestCase, @unchecked Sendable {
         try! httpClient.syncShutdown()
     }
 
+    @available(*, deprecated, message: "To avoid deprecation warnings for 'makeEventsParseFailureStream'")
     func testConnect() async throws {
         /// Make sure last tests don't affect this test's gateway connection
         try await Task.sleep(for: .seconds(5))
@@ -107,6 +108,7 @@ class GatewayConnectionTests: XCTestCase, @unchecked Sendable {
         XCTAssertEqual(bot.connectionId.load(ordering: .relaxed), 2)
     }
 
+    @available(*, deprecated, message: "To avoid deprecation warnings for 'makeEventsStream'")
     func testShardingGatewayManager() async throws {
         /// Make sure last tests don't affect this test's gateway connection
         try await Task.sleep(for: .seconds(5))
@@ -162,6 +164,7 @@ class GatewayConnectionTests: XCTestCase, @unchecked Sendable {
         await counter.waitFulfillment()
     }
 
+    @available(*, deprecated, message: "To avoid deprecation warnings for 'makeEventsStream'")
     func testGatewayStopsOnInvalidToken() async throws {
         /// Make sure last tests don't affect this test's gateway connection
         try await Task.sleep(for: .seconds(5))