Rename v2 types

Author: grdsdev

Examples/SlackClone/MessagesView.swift

@@ -35,7 +35,7 @@ final class MessagesViewModel {
     }
   }
 
-  private var realtimeChannelV2: RealtimeChannel?
+  private var realtimeChannelV2: RealtimeChannelV2?
   private var observationTask: Task<Void, Never>?
 
   func startObservingNewMessages() {

Package.resolved

@@ -21,7 +21,7 @@ final class CallbackManager: @unchecked Sendable {
   @discardableResult
   func addBroadcastCallback(
     event: String,
-    callback: @escaping @Sendable (_RealtimeMessage) -> Void
+    callback: @escaping @Sendable (RealtimeMessageV2) -> Void
   ) -> Int {
     mutableState.withValue {
       $0.id += 1
@@ -96,7 +96,7 @@ final class CallbackManager: @unchecked Sendable {
     }
   }
 
-  func triggerBroadcast(event: String, message: _RealtimeMessage) {
+  func triggerBroadcast(event: String, message: RealtimeMessageV2) {
     let broadcastCallbacks = mutableState.callbacks.compactMap {
       if case let .broadcast(callback) = $0 {
         return callback
@@ -110,7 +110,7 @@ final class CallbackManager: @unchecked Sendable {
   func triggerPresenceDiffs(
     joins: [String: Presence],
     leaves: [String: Presence],
-    rawMessage: _RealtimeMessage
+    rawMessage: RealtimeMessageV2
   ) {
     let presenceCallbacks = mutableState.callbacks.compactMap {
       if case let .presence(callback) = $0 {
@@ -139,7 +139,7 @@ struct PostgresCallback {
 struct BroadcastCallback {
   var id: Int
   var event: String
-  var callback: @Sendable (_RealtimeMessage) -> Void
+  var callback: @Sendable (RealtimeMessageV2) -> Void
 }
 
 struct PresenceCallback {

Sources/Realtime/CallbackManager.swift

@@ -15,7 +15,7 @@ public struct RealtimeChannelConfig: Sendable {
   public var presence: PresenceJoinConfig
 }
 
-public final class RealtimeChannel: @unchecked Sendable {
+public final class RealtimeChannelV2: @unchecked Sendable {
   public enum Status {
     case unsubscribed
     case subscribing
@@ -87,7 +87,7 @@ public final class RealtimeChannel: @unchecked Sendable {
 
     debug("subscribing to channel with body: \(joinConfig)")
 
-    try? await socket?.send(_RealtimeMessage(
+    try? await socket?.send(RealtimeMessageV2(
       joinRef: nil,
       ref: socket?.makeRef().description ?? "",
       topic: topic,
@@ -101,7 +101,7 @@ public final class RealtimeChannel: @unchecked Sendable {
     debug("unsubscribing from channel \(topic)")
 
     try await socket?.send(
-      _RealtimeMessage(
+      RealtimeMessageV2(
         joinRef: nil,
         ref: socket?.makeRef().description,
         topic: topic,
@@ -114,7 +114,7 @@ public final class RealtimeChannel: @unchecked Sendable {
   public func updateAuth(jwt: String) async throws {
     debug("Updating auth token for channel \(topic)")
     try await socket?.send(
-      _RealtimeMessage(
+      RealtimeMessageV2(
         joinRef: nil,
         ref: socket?.makeRef().description,
         topic: topic,
@@ -129,7 +129,7 @@ public final class RealtimeChannel: @unchecked Sendable {
       // TODO: use HTTP
     } else {
       try await socket?.send(
-        _RealtimeMessage(
+        RealtimeMessageV2(
           joinRef: nil,
           ref: socket?.makeRef().description,
           topic: topic,
@@ -151,7 +151,7 @@ public final class RealtimeChannel: @unchecked Sendable {
       )
     }
 
-    try await socket?.send(_RealtimeMessage(
+    try await socket?.send(RealtimeMessageV2(
       joinRef: nil,
       ref: socket?.makeRef().description,
       topic: topic,
@@ -165,7 +165,7 @@ public final class RealtimeChannel: @unchecked Sendable {
   }
 
   public func untrack() async throws {
-    try await socket?.send(_RealtimeMessage(
+    try await socket?.send(RealtimeMessageV2(
       joinRef: nil,
       ref: socket?.makeRef().description,
       topic: topic,
@@ -177,7 +177,7 @@ public final class RealtimeChannel: @unchecked Sendable {
     ))
   }
 
-  func onMessage(_ message: _RealtimeMessage) async throws {
+  func onMessage(_ message: RealtimeMessageV2) async throws {
     guard let eventType = message.eventType else {
       throw RealtimeError("Received message without event type: \(message)")
     }
@@ -331,8 +331,8 @@ public final class RealtimeChannel: @unchecked Sendable {
 
   /// Listen for broadcast messages sent by other clients within the same channel under a specific
   /// `event`.
-  public func broadcast(event: String) -> AsyncStream<_RealtimeMessage> {
-    let (stream, continuation) = AsyncStream<_RealtimeMessage>.makeStream()
+  public func broadcast(event: String) -> AsyncStream<RealtimeMessageV2> {
+    let (stream, continuation) = AsyncStream<RealtimeMessageV2>.makeStream()
 
     let id = callbackManager.addBroadcastCallback(event: event) {
       continuation.yield($0)

Sources/Realtime/Channel.swift

@@ -9,87 +9,3 @@ import Foundation
 
 @available(*, deprecated, renamed: "RealtimeMessage")
 public typealias Message = RealtimeMessage
-
-extension RealtimeChannel {
-  @available(
-    *,
-    deprecated,
-    message: "Please use one of postgresChanges, presenceChange, or broadcast methods that returns an AsyncSequence instead."
-  )
-  @discardableResult
-  public func on(
-    _ event: String,
-    filter: ChannelFilter,
-    handler: @escaping (_RealtimeMessage) -> Void
-  ) -> RealtimeChannel {
-    let stream: AsyncStream<HasRawMessage>
-
-    switch event.lowercased() {
-    case "postgres_changes":
-      switch filter.event?.uppercased() {
-      case "UPDATE":
-        stream = postgresChange(
-          UpdateAction.self,
-          schema: filter.schema ?? "public",
-          table: filter.table!,
-          filter: filter.filter
-        )
-        .map { $0 as HasRawMessage }
-        .eraseToStream()
-      case "INSERT":
-        stream = postgresChange(
-          InsertAction.self,
-          schema: filter.schema ?? "public",
-          table: filter.table!,
-          filter: filter.filter
-        )
-        .map { $0 as HasRawMessage }
-        .eraseToStream()
-      case "DELETE":
-        stream = postgresChange(
-          DeleteAction.self,
-          schema: filter.schema ?? "public",
-          table: filter.table!,
-          filter: filter.filter
-        )
-        .map { $0 as HasRawMessage }
-        .eraseToStream()
-      case "SELECT":
-        stream = postgresChange(
-          SelectAction.self,
-          schema: filter.schema ?? "public",
-          table: filter.table!,
-          filter: filter.filter
-        )
-        .map { $0 as HasRawMessage }
-        .eraseToStream()
-      default:
-        stream = postgresChange(
-          AnyAction.self,
-          schema: filter.schema ?? "public",
-          table: filter.table!,
-          filter: filter.filter
-        )
-        .map { $0 as HasRawMessage }
-        .eraseToStream()
-      }
-
-    case "presence":
-      stream = presenceChange().map { $0 as HasRawMessage }.eraseToStream()
-    case "broadcast":
-      stream = broadcast(event: filter.event!).map { $0 as HasRawMessage }.eraseToStream()
-    default:
-      fatalError(
-        "Unsupported event '\(event)'. Expected one of: postgres_changes, presence, or broadcast."
-      )
-    }
-
-    Task {
-      for await action in stream {
-        handler(action.rawMessage)
-      }
-    }
-
-    return self
-  }
-}

Sources/Realtime/Deprecated.swift

@@ -26,7 +26,7 @@ public protocol HasOldRecord {
 }
 
 public protocol HasRawMessage {
-  var rawMessage: _RealtimeMessage { get }
+  var rawMessage: RealtimeMessageV2 { get }
 }
 
 public struct InsertAction: PostgresAction, HasRecord, HasRawMessage {
@@ -35,7 +35,7 @@ public struct InsertAction: PostgresAction, HasRecord, HasRawMessage {
   public let columns: [Column]
   public let commitTimestamp: Date
   public let record: [String: AnyJSON]
-  public let rawMessage: _RealtimeMessage
+  public let rawMessage: RealtimeMessageV2
 }
 
 public struct UpdateAction: PostgresAction, HasRecord, HasOldRecord, HasRawMessage {
@@ -44,7 +44,7 @@ public struct UpdateAction: PostgresAction, HasRecord, HasOldRecord, HasRawMessa
   public let columns: [Column]
   public let commitTimestamp: Date
   public let record, oldRecord: [String: AnyJSON]
-  public let rawMessage: _RealtimeMessage
+  public let rawMessage: RealtimeMessageV2
 }
 
 public struct DeleteAction: PostgresAction, HasOldRecord, HasRawMessage {
@@ -53,7 +53,7 @@ public struct DeleteAction: PostgresAction, HasOldRecord, HasRawMessage {
   public let columns: [Column]
   public let commitTimestamp: Date
   public let oldRecord: [String: AnyJSON]
-  public let rawMessage: _RealtimeMessage
+  public let rawMessage: RealtimeMessageV2
 }
 
 public struct SelectAction: PostgresAction, HasRecord, HasRawMessage {
@@ -62,7 +62,7 @@ public struct SelectAction: PostgresAction, HasRecord, HasRawMessage {
   public let columns: [Column]
   public let commitTimestamp: Date
   public let record: [String: AnyJSON]
-  public let rawMessage: _RealtimeMessage
+  public let rawMessage: RealtimeMessageV2
 }
 
 public enum AnyAction: PostgresAction, HasRawMessage {
@@ -82,7 +82,7 @@ public enum AnyAction: PostgresAction, HasRawMessage {
     }
   }
 
-  public var rawMessage: _RealtimeMessage {
+  public var rawMessage: RealtimeMessageV2 {
     wrappedAction.rawMessage
   }
 }

Sources/Realtime/PostgresAction.swift

@@ -163,7 +163,7 @@ public final class Presence {
 
   // ----------------------------------------------------------------------
   /// The channel the Presence belongs to
-  weak var channel: OldRealtimeChannel?
+  weak var channel: RealtimeChannel?
 
   /// Caller to callback hooks
   var caller: Caller
@@ -215,7 +215,7 @@ public final class Presence {
     onSync = callback
   }
 
-  public init(channel: OldRealtimeChannel, opts: Options = Options.defaults) {
+  public init(channel: RealtimeChannel, opts: Options = Options.defaults) {
     state = [:]
     pendingDiffs = []
     self.channel = channel

Sources/Realtime/Presence.swift

@@ -22,5 +22,5 @@ public protocol PresenceAction: HasRawMessage {
 struct PresenceActionImpl: PresenceAction {
   var joins: [String: Presence]
   var leaves: [String: Presence]
-  var rawMessage: _RealtimeMessage
+  var rawMessage: RealtimeMessageV2
 }

Sources/Realtime/PresenceAction.swift

@@ -23,7 +23,7 @@ import Foundation
 /// Represnts pushing data to a `Channel` through the `Socket`
 public class Push {
   /// The channel sending the Push
-  public weak var channel: OldRealtimeChannel?
+  public weak var channel: RealtimeChannel?
 
   /// The event, for example `phx_join`
   public let event: String
@@ -62,7 +62,7 @@ public class Push {
   /// - parameter payload: Optional. The Payload to send, e.g. ["user_id": "abc123"]
   /// - parameter timeout: Optional. The push timeout. Default is 10.0s
   init(
-    channel: OldRealtimeChannel,
+    channel: RealtimeChannel,
     event: String,
     payload: Payload = [:],
     timeout: TimeInterval = Defaults.timeoutInterval