feat: add support for sound and video notification attachments (#10)

Author: ameter

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.7
+// swift-tools-version: 5.6
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription

Sources/AmplifyUtilsNotifications/AUNotificationPayload.swift

@@ -7,13 +7,33 @@
 
 import Foundation
 
-/// Defines the location of the image URL in a notification payload.
+/// Defines the location of the media URL in a notification payload.
 ///
 /// Conform to this protocol to define notification payload formats for use with AUNotificationService.
 /// It is not necessary to define the full message schema. Defining the subset of the message that
-/// contains the remote image URL is sufficient. See `PinpointNotificationPayload` for an example.
+/// contains the remote media URL is sufficient. See `PinpointNotificationPayload` for an example.
+///
+/// Supported Media Types:
+///
+/// Audio - 5MB max
+/// - kUTTypeAudioInterchangeFileFormat
+/// - kUTTypeWaveformAudio
+/// - kUTTypeMP3
+/// - kUTTypeMPEG4Audio
+///
+/// Image - 10 MB max
+/// - kUTTypeJPEG
+/// - kUTTypeGIF
+/// - kUTTypePNG
+///
+/// Movie - 50 MB max
+/// - kUTTypeMPEG
+/// - kUTTypeMPEG2Video
+/// - kUTTypeMPEG4
+/// - kUTTypeAVIMovie
+///
 public protocol AUNotificationPayload: Decodable {
-    var remoteImageURL: String? { get }
+    var remoteMediaURL: String? { get }
 }
 
 extension AUNotificationPayload {

Sources/AmplifyUtilsNotifications/AUNotificationService.swift

@@ -49,10 +49,10 @@ open class AUNotificationService: UNNotificationServiceExtension {
 
         if let bestAttemptContent = bestAttemptContent {
             // Modify the notification content
-            guard let attachment = getImageAttachment(request) else { return }
+            guard let mediaAttachment = getMediaAttachment(request) else { return }
 
             os_log(.debug, "created attachment")
-            bestAttemptContent.attachments = [attachment]
+            bestAttemptContent.attachments = [mediaAttachment]
         }
     }
 
@@ -67,15 +67,15 @@ open class AUNotificationService: UNNotificationServiceExtension {
         }
     }
 
-    private func getImageAttachment(_ request: UNNotificationRequest) -> UNNotificationAttachment? {
+    private func getMediaAttachment(_ request: UNNotificationRequest) -> UNNotificationAttachment? {
         guard let payloadData = try? payloadSchema.init(decoding: request.content.userInfo),
-              let mediaURLString = payloadData.remoteImageURL,
+              let mediaURLString = payloadData.remoteMediaURL,
               let mediaType = mediaURLString.split(separator: ".").last,
               let mediaURL = URL(string: mediaURLString),
               let mediaData = try? self.loadDataFromURL(mediaURL) else {
             return nil
         }
-        os_log(.debug, "got image data")
+        os_log(.debug, "got media data")
 
         let fileManager = FileManager.default
         let temporaryFolderName = ProcessInfo.processInfo.globallyUniqueString
@@ -87,12 +87,11 @@ open class AUNotificationService: UNNotificationServiceExtension {
                                             withIntermediateDirectories: true,
                                             attributes: nil)
 
-            // supported image types: jpg, gif, png
-            let imageFileIdentifier = "\(UUID().uuidString).\(String(mediaType))"
-            let fileURL = temporaryFolderURL.appendingPathComponent(imageFileIdentifier)
+            let mediaFileIdentifier = "\(UUID().uuidString).\(String(mediaType))"
+            let fileURL = temporaryFolderURL.appendingPathComponent(mediaFileIdentifier)
             try mediaData.write(to: fileURL)
 
-            return try UNNotificationAttachment(identifier: imageFileIdentifier, url: fileURL)
+            return try UNNotificationAttachment(identifier: mediaFileIdentifier, url: fileURL)
         } catch {
             return nil
         }

Sources/AmplifyUtilsNotifications/Payloads/PinpointNotificationPayload.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 struct PinpointNotificationPayload: AUNotificationPayload {
-    var remoteImageURL: String? {
+    var remoteMediaURL: String? {
         data.mediaURL
     }