Added a new upload endpoint

Author: martinmitrevski

Sources/StreamChat/APIClient/CDNClient/CDNClient.swift

@@ -40,6 +40,12 @@ public protocol CDNClient {
         progress: ((Double) -> Void)?,
         completion: @escaping (Result<UploadedFile, Error>) -> Void
     )
+    
+    func uploadAttachment<Payload>(
+        _ attachment: StreamAttachment<Payload>,
+        progress: ((Double) -> Void)?,
+        completion: @escaping (Result<UploadedFile, Error>) -> Void
+    )
 }
 
 public extension CDNClient {
@@ -104,13 +110,52 @@ class StreamCDNClient: CDNClient {
             let fileData = try? Data(contentsOf: uploadingState.localFileURL) else {
             return completion(.failure(ClientError.AttachmentUploading(id: attachment.id)))
         }
+        let endpoint = Endpoint<FileUploadPayload>.uploadAttachment(with: attachment.id.cid, type: attachment.type)
+        
+        uploadAttachment(
+            endpoint: endpoint,
+            fileData: fileData,
+            uploadingState: uploadingState,
+            progress: progress,
+            completion: completion
+        )
+    }
+    
+    func uploadAttachment<Payload>(
+        _ attachment: StreamAttachment<Payload>,
+        progress: ((Double) -> Void)? = nil,
+        completion: @escaping (Result<UploadedFile, Error>) -> Void
+    ) {
+        guard
+            let uploadingState = attachment.uploadingState,
+            let fileData = try? Data(contentsOf: uploadingState.localFileURL) else {
+            return completion(.failure(ClientError.Unknown()))
+        }
+
+        let endpoint = Endpoint<FileUploadPayload>.uploadAttachment(type: attachment.type)
+        
+        uploadAttachment(
+            endpoint: endpoint,
+            fileData: fileData,
+            uploadingState: uploadingState,
+            progress: progress,
+            completion: completion
+        )
+    }
+    
+    private func uploadAttachment<ResponsePayload>(
+        endpoint: Endpoint<ResponsePayload>,
+        fileData: Data,
+        uploadingState: AttachmentUploadingState,
+        progress: ((Double) -> Void)? = nil,
+        completion: @escaping (Result<UploadedFile, Error>) -> Void
+    ) {
         // Encode locally stored attachment into multipart form data
         let multipartFormData = MultipartFormData(
             fileData,
             fileName: uploadingState.localFileURL.lastPathComponent,
             mimeType: uploadingState.file.type.mimeType
         )
-        let endpoint = Endpoint<FileUploadPayload>.uploadAttachment(with: attachment.id.cid, type: attachment.type)
 
         encoder.encodeRequest(for: endpoint) { [weak self] (requestResult) in
             var urlRequest: URLRequest

Sources/StreamChat/APIClient/Endpoints/AttachmentEndpoints.swift

@@ -7,7 +7,17 @@ import Foundation
 extension Endpoint {
     static func uploadAttachment(with cid: ChannelId, type: AttachmentType) -> Endpoint<FileUploadPayload> {
         .init(
-            path: .uploadAttachment(channelId: cid.apiPath, type: type == .image ? "image" : "file"),
+            path: .uploadChannelAttachment(channelId: cid.apiPath, type: type == .image ? "image" : "file"),
+            method: .post,
+            queryItems: nil,
+            requiresConnectionId: false,
+            body: nil
+        )
+    }
+    
+    static func uploadAttachment(type: AttachmentType) -> Endpoint<FileUploadPayload> {
+        .init(
+            path: .uploadAttachment(type == .image ? "image" : "file"),
             method: .post,
             queryItems: nil,
             requiresConnectionId: false,

Sources/StreamChat/APIClient/Endpoints/EndpointPath+OfflineRequest.swift

@@ -11,11 +11,11 @@ extension EndpointPath {
             return true
         case .createChannel, .connect, .sync, .users, .guest, .members, .partialMemberUpdate, .search, .devices, .channels, .updateChannel,
              .deleteChannel, .channelUpdate, .muteChannel, .showChannel, .truncateChannel, .markChannelRead, .markChannelUnread,
-             .markAllChannelsRead, .channelEvent, .stopWatchingChannel, .pinnedMessages, .uploadAttachment, .message,
+             .markAllChannelsRead, .channelEvent, .stopWatchingChannel, .pinnedMessages, .uploadChannelAttachment, .message,
              .replies, .reactions, .messageAction, .banMember, .flagUser, .flagMessage, .muteUser, .translateMessage,
              .callToken, .createCall, .deleteFile, .deleteImage, .og, .appSettings, .threads, .thread, .markThreadRead, .markThreadUnread,
              .polls, .pollsQuery, .poll, .pollOption, .pollOptions, .pollVotes, .pollVoteInMessage, .pollVote,
-             .unread, .blockUser, .unblockUser, .drafts, .reminders, .reminder, .liveLocations:
+             .unread, .blockUser, .unblockUser, .drafts, .reminders, .reminder, .liveLocations, .uploadAttachment:
             return false
         }
     }

Sources/StreamChat/APIClient/Endpoints/EndpointPath.swift

@@ -36,7 +36,8 @@ enum EndpointPath: Codable {
     case channelEvent(String)
     case stopWatchingChannel(String)
     case pinnedMessages(String)
-    case uploadAttachment(channelId: String, type: String)
+    case uploadChannelAttachment(channelId: String, type: String)
+    case uploadAttachment(String)
 
     case sendMessage(ChannelId)
     case message(MessageId)
@@ -125,7 +126,8 @@ enum EndpointPath: Codable {
         case let .channelEvent(channelId): return "channels/\(channelId)/event"
         case let .stopWatchingChannel(channelId): return "channels/\(channelId)/stop-watching"
         case let .pinnedMessages(channelId): return "channels/\(channelId)/pinned_messages"
-        case let .uploadAttachment(channelId, type): return "channels/\(channelId)/\(type)"
+        case let .uploadChannelAttachment(channelId, type): return "channels/\(channelId)/\(type)"
+        case let .uploadAttachment(type): return "uploads/\(type)"
 
         case let .sendMessage(channelId): return "channels/\(channelId.apiPath)/message"
         case let .message(messageId): return "messages/\(messageId)"

Sources/StreamChat/Models/Attachments/ChatMessageAttachment.swift

@@ -4,6 +4,39 @@
 
 import Foundation
 
+public struct StreamAttachment<Payload> {
+    /// The attachment type.
+    public let type: AttachmentType
+
+    /// The attachment payload.
+    public var payload: Payload
+
+    /// The downloading state of the attachment.
+    ///
+    /// Reflects the downloading progress for attachments.
+    public let downloadingState: AttachmentDownloadingState?
+    
+    /// The uploading state of the attachment.
+    ///
+    /// Reflects uploading progress for local attachments that require file uploading.
+    /// Is `nil` for local attachments that don't need to be uploaded.
+    ///
+    /// Becomes `nil` when the message with the current attachment is sent.
+    public let uploadingState: AttachmentUploadingState?
+
+    public init(
+        type: AttachmentType,
+        payload: Payload,
+        downloadingState: AttachmentDownloadingState?,
+        uploadingState: AttachmentUploadingState?
+    ) {
+        self.type = type
+        self.payload = payload
+        self.downloadingState = downloadingState
+        self.uploadingState = uploadingState
+    }
+}
+
 /// A type representing a chat message attachment.
 /// `ChatMessageAttachment<Payload>` is an immutable snapshot of message attachment at the given time.
 @dynamicMemberLookup

TestTools/StreamChatTestTools/Extensions/EndpoinPath+Equatable.swift

@@ -28,7 +28,7 @@ extension EndpointPath: Equatable {
         case let (.channelEvent(string1), .channelEvent(string2)): return string1 == string2
         case let (.stopWatchingChannel(string1), .stopWatchingChannel(string2)): return string1 == string2
         case let (.pinnedMessages(string1), .pinnedMessages(string2)): return string1 == string2
-        case let (.uploadAttachment(channelId1, type1), .uploadAttachment(channelId2, type2)): return channelId1 == channelId2 &&
+        case let (.uploadChannelAttachment(channelId1, type1), .uploadChannelAttachment(channelId2, type2)): return channelId1 == channelId2 &&
             type1 ==
             type2
         case let (.sendMessage(channelId1), .sendMessage(channelId2)): return channelId1 == channelId2

Tests/StreamChatTests/APIClient/Endpoints/AttachmentEndpoints_Tests.swift

@@ -22,7 +22,7 @@ final class AttachmentEndpoints_Tests: XCTestCase {
 
         for (type, pathComponent) in testCases {
             let expectedEndpoint: Endpoint<FileUploadPayload> = .init(
-                path: .uploadAttachment(channelId: id.cid.apiPath, type: pathComponent),
+                path: .uploadChannelAttachment(channelId: id.cid.apiPath, type: pathComponent),
                 method: .post,
                 queryItems: nil,
                 requiresConnectionId: false,

Tests/StreamChatTests/APIClient/Endpoints/EndpointPath_Tests.swift

@@ -121,7 +121,7 @@ final class EndpointPathTests: XCTestCase {
         assertResultEncodingAndDecoding(.channelEvent("channel_idq"))
         assertResultEncodingAndDecoding(.stopWatchingChannel("channel_idq"))
         assertResultEncodingAndDecoding(.pinnedMessages("channel_idq"))
-        assertResultEncodingAndDecoding(.uploadAttachment(channelId: "channel_id", type: "file"))
+        assertResultEncodingAndDecoding(.uploadChannelAttachment(channelId: "channel_id", type: "file"))
 
         assertResultEncodingAndDecoding(.sendMessage(ChannelId(type: .messaging, id: "the_id")))
         assertResultEncodingAndDecoding(.message("message_idm"))