Add alert to live activity start notifications

Author: nakajima

Sources/APNSCore/Alert/APNSAlertNotificationContent.swift

@@ -13,7 +13,7 @@
 //===----------------------------------------------------------------------===//
 
 /// The information for displaying an alert.
-public struct APNSAlertNotificationContent: Encodable, Sendable {
+public struct APNSAlertNotificationContent: Encodable, Sendable, Hashable {
     public struct StringValue: Encodable, Hashable, Sendable {
         internal enum Configuration: Encodable, Hashable {
             case raw(String)

Sources/APNSCore/LiveActivity/APNSLiveActivityNotification.swift

@@ -38,6 +38,16 @@ public struct APNSLiveActivityNotification<ContentState: Encodable & Hashable &
         }
     }
 
+    public var alert: APNSAlertNotificationContent? {
+        get {
+            return self.aps.alert
+        }
+
+        set {
+            self.aps.alert = newValue
+        }
+    }
+
     /// Event type e.g. update
     public var event: any APNSLiveActivityNotificationEvent {
         get {
@@ -48,14 +58,17 @@ public struct APNSLiveActivityNotification<ContentState: Encodable & Hashable &
                 return APNSLiveActivityNotificationEventUpdate()
             default:
                 guard let attributesType = self.aps.attributesType,
-                    let state = self.aps.attributesContent
+                    let state = self.aps.attributesContent,
+                    let alert = self.aps.alert
                 else {
                     // Default to update
                     return APNSLiveActivityNotificationEventUpdate()
                 }
 
                 return APNSLiveActivityNotificationEventStart(
-                    attributes: .init(type: attributesType, state: state))
+                    attributes: .init(type: attributesType, state: state),
+                    alert: alert
+                )
             }
         }
 
@@ -173,8 +186,7 @@ public struct APNSLiveActivityNotification<ContentState: Encodable & Hashable &
 
         self.aps = APNSLiveActivityNotificationAPSStorage(
             timestamp: timestamp,
-            event: event.rawValue,
-            attributes: attributes,
+            event: event,
             contentState: contentState,
             dismissalDate: dismissalDate.dismissal
         )

Sources/APNSCore/LiveActivity/APNSLiveActivityNotificationAPSStorage.swift

@@ -22,6 +22,7 @@ struct APNSLiveActivityNotificationAPSStorage<ContentState: Encodable & Hashable
         case dismissalDate = "dismissal-date"
         case attributesType = "attributes-type"
         case attributesContent = "attributes"
+        case alert = "alert"
     }
 
     var timestamp: Int
@@ -30,19 +31,23 @@ struct APNSLiveActivityNotificationAPSStorage<ContentState: Encodable & Hashable
     var attributesContent: ContentState?
     var contentState: ContentState
     var dismissalDate: Int?
+    var alert: APNSAlertNotificationContent?
 
     init(
         timestamp: Int,
-        event: String,
-        attributes: APNSLiveActivityNotificationEventStart<ContentState>.Attributes?,
+        event: any APNSLiveActivityNotificationEvent,
         contentState: ContentState,
         dismissalDate: Int?
     ) {
         self.timestamp = timestamp
-        self.event = event
-        self.attributesType = attributes?.type
-        self.attributesContent = attributes?.state
         self.contentState = contentState
         self.dismissalDate = dismissalDate
+        self.event = event.rawValue
+
+        if let event = event as? APNSLiveActivityNotificationEventStart<ContentState> {
+            self.attributesType = event.attributes.type
+            self.attributesContent = event.attributes.state
+            self.alert = event.alert
+        }
     }
 }

Sources/APNSCore/LiveActivity/APNSLiveActivityNotificationEvent.swift

@@ -44,9 +44,11 @@ public struct APNSLiveActivityNotificationEventStart<State: Encodable & Hashable
 
     public let rawValue = "start"
     public let attributes: Attributes
+    public let alert: APNSAlertNotificationContent
 
-    public init(attributes: Attributes) {
+    public init(attributes: Attributes, alert: APNSAlertNotificationContent) {
         self.attributes = attributes
+        self.alert = alert
     }
 }
 
@@ -64,9 +66,11 @@ extension APNSLiveActivityNotificationEvent where Self == APNSLiveActivityNotifi
 
 extension APNSLiveActivityNotificationEvent
 where Self: APNSLiveActivityNotificationEventStartStateProtocol {
-    public static func start(type: String, state: State) -> APNSLiveActivityNotificationEventStart<
-        State
-    > {
-        .init(attributes: .init(type: type, state: state))
+    public static func start(type: String, state: State, alert: APNSAlertNotificationContent)
+        -> APNSLiveActivityNotificationEventStart<
+            State
+        >
+    {
+        .init(attributes: .init(type: type, state: state), alert: alert)
     }
 }

Tests/APNSTests/LiveActivity/APNSLiveActivityNotificationTests.swift

@@ -53,14 +53,16 @@ final class APNSLiveActivityNotificationTests: XCTestCase {
             contentState: State(),
             // Need the fully qualified name here
             event: APNSLiveActivityNotificationEventStart(
-                attributes: .init(type: "State", state: State())),
+                attributes: .init(type: "State", state: State()),
+                alert: .init(title: .raw("Update"))
+            ),
             timestamp: 1_672_680_658)
 
         let encoder = JSONEncoder()
         let data = try encoder.encode(notification)
 
         let expectedJSONString = """
-            {"aps":{"event":"start", "attributes-type": "State", "attributes": {"string":"Test","number":123},"content-state":{"string":"Test","number":123},"timestamp":1672680658}}
+            {"aps":{"event":"start", "alert": { "title": "Update" }, "attributes-type": "State", "attributes": {"string":"Test","number":123},"content-state":{"string":"Test","number":123},"timestamp":1672680658}}
             """
 
         let jsonObject1 = try JSONSerialization.jsonObject(with: data) as! NSDictionary