[ECO-5577] Pre-v1 public API audit

Example/AblyChatExample/ContentView.swift

@@ -60,7 +60,7 @@ struct ContentView: View {
         var id: String {
             switch self {
             case let .message(item):
-                item.message.id
+                item.message.serial
             case let .presence(item):
                 item.presence.member.updatedAt.description
             }
@@ -119,9 +119,9 @@ struct ContentView: View {
                                 currentClientID: currentClientID,
                                 item: messageItem,
                                 isEditing: Binding(get: {
-                                    editingItemID == messageItem.message.id
+                                    editingItemID == messageItem.message.serial
                                 }, set: { editing in
-                                    editingItemID = editing ? messageItem.message.id : nil
+                                    editingItemID = editing ? messageItem.message.serial : nil
                                     newMessage = editing ? messageItem.message.text : ""
                                 }),
                                 onDeleteMessage: {
@@ -265,7 +265,7 @@ struct ContentView: View {
                     )
                 }
             case .updated, .deleted:
-                if let index = listItems.firstIndex(where: { $0.id == message.id }) {
+                if let index = listItems.firstIndex(where: { $0.id == message.serial }) {
                     listItems[index] = .message(
                         .init(
                             message: message,
@@ -300,10 +300,10 @@ struct ContentView: View {
             do {
                 try withAnimation {
                     if let reactedMessageItem = listItemWithMessageSerial(summaryEvent.summary.messageSerial) {
-                        if let index = listItems.firstIndex(where: { $0.id == reactedMessageItem.message.id }) {
+                        if let index = listItems.firstIndex(where: { $0.id == reactedMessageItem.message.serial }) {
                             listItems[index] = try .message(
                                 .init(
-                                    message: reactedMessageItem.message.with(summaryEvent: summaryEvent),
+                                    message: reactedMessageItem.message.with(summaryEvent),
                                     isSender: reactedMessageItem.message.clientID == currentClientID,
                                 ),
                             )
@@ -397,7 +397,7 @@ struct ContentView: View {
         }
 
         if let editingMessageItem = listItems.compactMap({ listItem -> MessageListItem? in
-            if case let .message(message) = listItem, message.message.id == editingItemID {
+            if case let .message(message) = listItem, message.message.serial == editingItemID {
                 return message
             }
             return nil
@@ -423,13 +423,13 @@ struct ContentView: View {
 
     func addMessageReaction(_ reaction: String, messageSerial: String) {
         Task {
-            try await room().messages.reactions.send(to: messageSerial, params: .init(name: reaction, type: .distinct))
+            try await room().messages.reactions.send(messageSerial: messageSerial, params: .init(name: reaction, type: .distinct))
         }
     }
 
     func deleteMessageReaction(_ reaction: String, messageSerial: String) {
         Task {
-            try await room().messages.reactions.delete(from: messageSerial, params: .init(name: reaction, type: .distinct))
+            try await room().messages.reactions.delete(messageSerial: messageSerial, params: .init(name: reaction, type: .distinct))
         }
     }
 

Example/AblyChatExample/MessageViews/MessageReactionSummaryView.swift

@@ -15,7 +15,7 @@ struct MessageReactionSummaryView: View {
 
     private let maxReactionsCount = 5
 
-    var reactions: [String: MessageReactionSummary.ClientIdList] {
+    var reactions: [String: MessageReactionSummary.ClientIDList] {
         summary.distinct
     }
 
@@ -64,7 +64,7 @@ struct MessageReactionSummaryView: View {
                 showAllReactionsSheet = true
             }
             if let emoji = selectedEmoji {
-                if reactions[emoji]?.clientIds.contains(currentClientID) ?? false {
+                if reactions[emoji]?.clientIDs.contains(currentClientID) ?? false {
                     Button("Remove my \(emoji)", role: .destructive) {
                         onDeleteReaction(emoji)
                     }

Example/AblyChatExample/MessageViews/MessageReactionsSheet.swift

@@ -17,9 +17,9 @@ struct MessageReactionsSheet: View {
     @Environment(\.dismiss)
     private var dismiss
 
-    init(uniqueOrDistinct: [String: MessageReactionSummary.ClientIdList]) {
+    init(uniqueOrDistinct: [String: MessageReactionSummary.ClientIDList]) {
         for (emoji, clientList) in uniqueOrDistinct {
-            for clientId in clientList.clientIds {
+            for clientId in clientList.clientIDs {
                 let key = "\(clientId)-\(emoji)"
                 reactions[key] = ReactionItem(
                     emoji: emoji,

Example/AblyChatExample/Mocks/Misc.swift

@@ -41,10 +41,6 @@ final class MockMessagesPaginatedResult: PaginatedResult {
         self.roomName = roomName
         self.numberOfMockMessages = numberOfMockMessages
     }
-
-    static func == (_: MockMessagesPaginatedResult, _: MockMessagesPaginatedResult) -> Bool {
-        fatalError("Not implemented")
-    }
 }
 
 enum MockStrings {

Example/AblyChatExample/Mocks/MockClients.swift

@@ -226,15 +226,15 @@ class MockMessageReactions: MessageReactions {
         MessageReactionSummary(
             messageSerial: messageSerial,
             unique: [:],
-            distinct: reactions.filter { $0.messageSerial == messageSerial }.reduce(into: [String: MessageReactionSummary.ClientIdList]()) { dict, newItem in
+            distinct: reactions.filter { $0.messageSerial == messageSerial }.reduce(into: [String: MessageReactionSummary.ClientIDList]()) { dict, newItem in
                 if var oldItem = dict[newItem.name] {
-                    if !oldItem.clientIds.contains(newItem.clientID) {
-                        oldItem.clientIds.append(newItem.clientID)
+                    if !oldItem.clientIDs.contains(newItem.clientID) {
+                        oldItem.clientIDs.append(newItem.clientID)
                         oldItem.total += 1
                     }
                     dict[newItem.name] = oldItem
                 } else {
-                    dict[newItem.name] = MessageReactionSummary.ClientIdList(total: 1, clientIds: [newItem.clientID], clipped: false)
+                    dict[newItem.name] = MessageReactionSummary.ClientIDList(total: 1, clientIDs: [newItem.clientID], clipped: false)
                 }
             },
             multiple: [:],
@@ -246,7 +246,7 @@ class MockMessageReactions: MessageReactions {
         self.roomName = roomName
     }
 
-    func send(to messageSerial: String, params: SendMessageReactionParams) async throws(ARTErrorInfo) {
+    func send(messageSerial: String, params: SendMessageReactionParams) async throws(ARTErrorInfo) {
         reactions.append(
             MessageReaction(
                 type: .distinct,
@@ -265,7 +265,7 @@ class MockMessageReactions: MessageReactions {
         )
     }
 
-    func delete(from messageSerial: String, params: DeleteMessageReactionParams) async throws(ARTErrorInfo) {
+    func delete(messageSerial: String, params: DeleteMessageReactionParams) async throws(ARTErrorInfo) {
         reactions.removeAll { reaction in
             reaction.messageSerial == messageSerial && reaction.name == params.name && reaction.clientID == clientID
         }
@@ -373,7 +373,7 @@ class MockTyping: Typing {
                         MockStrings.names.randomElement()!,
                         MockStrings.names.randomElement()!,
                     ],
-                    change: .init(clientId: MockStrings.names.randomElement()!, type: .started),
+                    change: .init(clientID: MockStrings.names.randomElement()!, type: .started),
                 )
             },
             interval: 2,
@@ -390,7 +390,7 @@ class MockTyping: Typing {
             TypingSetEvent(
                 type: .setChanged,
                 currentlyTyping: [clientID],
-                change: .init(clientId: clientID, type: .started),
+                change: .init(clientID: clientID, type: .started),
             ),
         )
     }
@@ -400,7 +400,7 @@ class MockTyping: Typing {
             TypingSetEvent(
                 type: .setChanged,
                 currentlyTyping: [],
-                change: .init(clientId: clientID, type: .stopped),
+                change: .init(clientID: clientID, type: .stopped),
             ),
         )
     }
@@ -568,7 +568,7 @@ class MockOccupancy: Occupancy {
         OccupancyData(connections: 10, presenceMembers: 5)
     }
 
-    func current() throws(ARTErrorInfo) -> AblyChat.OccupancyData? {
+    var current: AblyChat.OccupancyData? {
         OccupancyData(connections: 10, presenceMembers: 5)
     }
 }

Sources/AblyChat/ChatAPI.swift

@@ -11,7 +11,7 @@ internal final class ChatAPI {
     private let realtime: any InternalRealtimeClientProtocol
     private let apiVersionV4 = "/chat/v4"
 
-    public init(realtime: any InternalRealtimeClientProtocol) {
+    internal init(realtime: any InternalRealtimeClientProtocol) {
         self.realtime = realtime
     }
 

Sources/AblyChat/DefaultMessageReactions.swift

@@ -19,7 +19,7 @@ internal final class DefaultMessageReactions: MessageReactions {
     }
 
     // (CHA-MR4) Users should be able to send a reaction to a message via the `send` method of the `MessagesReactions` object
-    internal func send(to messageSerial: String, params: SendMessageReactionParams) async throws(ARTErrorInfo) {
+    internal func send(messageSerial: String, params: SendMessageReactionParams) async throws(ARTErrorInfo) {
         do {
             var count = params.count
             if params.type == .multiple, params.count == nil {
@@ -40,7 +40,7 @@ internal final class DefaultMessageReactions: MessageReactions {
     }
 
     // (CHA-MR11) Users should be able to delete a reaction from a message via the `delete` method of the `MessagesReactions` object
-    internal func delete(from messageSerial: String, params: DeleteMessageReactionParams) async throws(ARTErrorInfo) {
+    internal func delete(messageSerial: String, params: DeleteMessageReactionParams) async throws(ARTErrorInfo) {
         let reactionType = params.type ?? options.defaultMessageReactionType
         if reactionType != .unique, params.name == nil {
             throw ARTErrorInfo(chatError: .unableDeleteReactionWithoutName(reactionType: reactionType.rawValue))

Sources/AblyChat/DefaultOccupancy.swift

@@ -21,7 +21,7 @@ internal final class DefaultOccupancy: Occupancy {
     internal func subscribe(_ callback: @escaping @MainActor (OccupancyEvent) -> Void) -> some Subscription {
         // CHA-O4e (we use a fatalError for this programmer error, which is the idiomatic thing to do for Swift)
         guard options.enableEvents else {
-            fatalError("In order to be able to subscribe to presence events, please set enableEvents to true in the room's occupancy options.")
+            fatalError("In order to be able to subscribe to occupancy events, please set enableEvents to true in the room's occupancy options.")
         }
 
         logger.log(message: "Subscribing to occupancy events", level: .debug)
@@ -68,11 +68,12 @@ internal final class DefaultOccupancy: Occupancy {
     }
 
     // (CHA-O7a) The current method should return the latest occupancy numbers received over the realtime connection in a [meta]occupancy event.
-    internal func current() throws(ARTErrorInfo) -> OccupancyData? {
-        // CHA-O7c
-        if !options.enableEvents {
-            throw ARTErrorInfo(chatError: .occupancyEventsNotEnabled)
+    internal var current: OccupancyData? {
+        // CHA-O7c (we use a fatalError for this programmer error, which is the idiomatic thing to do for Swift)
+        guard options.enableEvents else {
+            fatalError("In order to be able to fetch the last received occupancy event, please set enableEvents to true in the room's occupancy options.")
         }
+
         // CHA-07a
         // CHA-07b
         return lastOccupancyData

Sources/AblyChat/DefaultTyping.swift

@@ -57,7 +57,7 @@ internal final class DefaultTyping: Typing {
                         TypingSetEvent(
                             type: .setChanged,
                             currentlyTyping: typingTimerManager.currentlyTypingClientIDs(),
-                            change: .init(clientId: messageClientID, type: .stopped),
+                            change: .init(clientID: messageClientID, type: .stopped),
                         ),
                     )
                 }
@@ -67,7 +67,7 @@ internal final class DefaultTyping: Typing {
                     TypingSetEvent(
                         type: .setChanged,
                         currentlyTyping: typingTimerManager.currentlyTypingClientIDs(),
-                        change: .init(clientId: messageClientID, type: .started),
+                        change: .init(clientID: messageClientID, type: .started),
                     ),
                 )
             }
@@ -90,7 +90,7 @@ internal final class DefaultTyping: Typing {
                     TypingSetEvent(
                         type: .setChanged,
                         currentlyTyping: typingTimerManager.currentlyTypingClientIDs(),
-                        change: .init(clientId: messageClientID, type: .stopped),
+                        change: .init(clientID: messageClientID, type: .stopped),
                     ),
                 )
             }

Sources/AblyChat/DiscontinuityEvent.swift

@@ -1,6 +1,6 @@
 import Ably
 
-public struct DiscontinuityEvent: Sendable, Equatable {
+public struct DiscontinuityEvent: Sendable {
     /// The error associated with this discontinuity.
     public var error: ARTErrorInfo
 

Sources/AblyChat/Errors.swift

@@ -9,6 +9,8 @@ public let errorDomain = "AblyChatErrorDomain"
 
 /**
  The error codes for errors in the ``errorDomain`` error domain.
+
+ - Note: Future minor version updates of the library may add new values to this enum. Bear this in mind if you wish to switch exhaustively over it.
  */
 public enum ErrorCode: Int {
     /// The user attempted to perform an invalid action.
@@ -177,7 +179,6 @@ internal enum ChatError {
     case clientIdRequired
     case attachSerialIsNotDefined
     case channelFailedToAttach(cause: ARTErrorInfo?)
-    case occupancyEventsNotEnabled
 
     internal var codeAndStatusCode: ErrorCodeAndStatusCode {
         switch self {
@@ -216,8 +217,6 @@ internal enum ChatError {
             .fixedStatusCode(.badRequest)
         case .channelFailedToAttach:
             .fixedStatusCode(.badRequest)
-        case .occupancyEventsNotEnabled:
-            .fixedStatusCode(.badRequest)
         }
     }
 
@@ -278,8 +277,6 @@ internal enum ChatError {
             "Channel is attached, but attachSerial is not defined."
         case let .channelFailedToAttach(cause):
             "Channel failed to attach: \(String(describing: cause))"
-        case .occupancyEventsNotEnabled:
-            "Cannot perform operation because occupancy events are not enabled for this room."
         }
     }
 
@@ -304,8 +301,7 @@ internal enum ChatError {
              .messageRejectedByBeforePublishRule,
              .messageRejectedByModeration,
              .clientIdRequired,
-             .attachSerialIsNotDefined,
-             .occupancyEventsNotEnabled:
+             .attachSerialIsNotDefined:
             nil
         }
     }

Sources/AblyChat/InternalError.swift

@@ -31,12 +31,6 @@ internal enum InternalError: Error {
     }
 }
 
-extension InternalError: Equatable {
-    internal static func == (lhs: InternalError, rhs: InternalError) -> Bool {
-        lhs.toARTErrorInfo() == rhs.toARTErrorInfo()
-    }
-}
-
 internal extension ARTErrorInfo {
     func toInternalError() -> InternalError {
         .errorInfo(self)