Add TimelineProxy (update sdk to 0.0.7-november23) (#2178)

* Refactor RoomProxy * Refactor paginateBackwards * Refactor sendReadReceipt * Refactor messageEventContent APIs * Refactor sendMessage * Refactor toggleReaction * Refactor send attachments * Refactor sendLocation * Refactor cancel/retry send * ⚠️ Fix encryption build errors * Refactor editMessage * Refactor retryDecryption * Refactor fetchDetails * Refactor polls APIs * Refactor fetchMembers * Refactor RoomTimelineProviderProtocol * Update sdk to 0.0.7-november23 * Fix UTs * Fix comment * Delete old workaround * Move TimelineProxyError * Delete queue warnings * Fix key listener * Add pollHistory timeline property * Refactor room/timeline subscriptions * Delete unused code
2026-11-03 06:55:59 +00:00 · 2023-11-28 20:01:35 +01:00
parent fb2bc1c39a
commit e7494164b2
18 changed files with 1212 additions and 1085 deletions
@@ -0,0 +1,127 @@
+//
+// Copyright 2023 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Combine
+import Foundation
+import MatrixRustSDK
+
+enum TimelineProxyError: Error, Equatable {
+    case failedEditingMessage
+    case failedPaginatingBackwards
+    case failedSendingMessage
+    case failedSendingReaction
+    case failedSendingReadReceipt
+    case failedSendingMedia
+    
+    // Polls
+    case failedCreatingPoll
+    case failedEditingPoll
+    case failedEndingPoll
+    case failedSendingPollResponse
+}
+
+// sourcery: AutoMockable
+protocol TimelineProxyProtocol {
+    var timelineProvider: RoomTimelineProviderProtocol { get }
+    func subscribeForUpdates() async
+    
+    /// Cancels a failed message given its transaction ID from the timeline
+    func cancelSend(transactionID: String) async
+    
+    func editMessage(_ message: String,
+                     html: String?,
+                     original eventID: String,
+                     intentionalMentions: IntentionalMentions) async -> Result<Void, TimelineProxyError>
+    
+    func fetchDetails(for eventID: String)
+    
+    func messageEventContent(for eventID: String) -> RoomMessageEventContentWithoutRelation?
+    
+    func retryDecryption(for sessionID: String) async
+    
+    /// Retries sending a failed message given its transaction ID
+    func retrySend(transactionID: String) async
+    
+    func paginateBackwards(requestSize: UInt, untilNumberOfItems: UInt) async -> Result<Void, TimelineProxyError>
+    
+    func sendAudio(url: URL,
+                   audioInfo: AudioInfo,
+                   progressSubject: CurrentValueSubject<Double, Never>?,
+                   requestHandle: @MainActor (SendAttachmentJoinHandleProtocol) -> Void) async -> Result<Void, TimelineProxyError>
+    
+    func sendFile(url: URL,
+                  fileInfo: FileInfo,
+                  progressSubject: CurrentValueSubject<Double, Never>?,
+                  requestHandle: @MainActor (SendAttachmentJoinHandleProtocol) -> Void) async -> Result<Void, TimelineProxyError>
+    
+    func sendImage(url: URL,
+                   thumbnailURL: URL,
+                   imageInfo: ImageInfo,
+                   progressSubject: CurrentValueSubject<Double, Never>?,
+                   requestHandle: @MainActor (SendAttachmentJoinHandleProtocol) -> Void) async -> Result<Void, TimelineProxyError>
+    
+    func sendLocation(body: String,
+                      geoURI: GeoURI,
+                      description: String?,
+                      zoomLevel: UInt8?,
+                      assetType: AssetType?) async -> Result<Void, TimelineProxyError>
+    
+    func sendVideo(url: URL,
+                   thumbnailURL: URL,
+                   videoInfo: VideoInfo,
+                   progressSubject: CurrentValueSubject<Double, Never>?,
+                   requestHandle: @MainActor (SendAttachmentJoinHandleProtocol) -> Void) async -> Result<Void, TimelineProxyError>
+    
+    func sendVoiceMessage(url: URL,
+                          audioInfo: AudioInfo,
+                          waveform: [UInt16],
+                          progressSubject: CurrentValueSubject<Double, Never>?,
+                          requestHandle: @MainActor (SendAttachmentJoinHandleProtocol) -> Void) async -> Result<Void, TimelineProxyError>
+    
+    func sendReadReceipt(for eventID: String) async -> Result<Void, TimelineProxyError>
+    
+    func sendMessageEventContent(_ messageContent: RoomMessageEventContentWithoutRelation) async -> Result<Void, TimelineProxyError>
+    
+    func sendMessage(_ message: String,
+                     html: String?,
+                     inReplyTo eventID: String?,
+                     intentionalMentions: IntentionalMentions) async -> Result<Void, TimelineProxyError>
+    
+    func toggleReaction(_ reaction: String, to eventID: String) async -> Result<Void, TimelineProxyError>
+    
+    // Polls
+    func createPoll(question: String, answers: [String], pollKind: Poll.Kind) async -> Result<Void, TimelineProxyError>
+    
+    func editPoll(original eventID: String,
+                  question: String,
+                  answers: [String],
+                  pollKind: Poll.Kind) async -> Result<Void, TimelineProxyError>
+    
+    func endPoll(pollStartID: String, text: String) async -> Result<Void, TimelineProxyError>
+    
+    func sendPollResponse(pollStartID: String, answers: [String]) async -> Result<Void, TimelineProxyError>
+}
+
+extension TimelineProxyProtocol {
+    func sendMessage(_ message: String,
+                     html: String?,
+                     intentionalMentions: IntentionalMentions) async -> Result<Void, TimelineProxyError> {
+        await sendMessage(message,
+                          html: html,
+                          inReplyTo: nil,
+                          intentionalMentions: intentionalMentions)
+    }
+}